SoPattern Class |
Node that defines the pattern to use when rendering shapes.
Namespace: OIV.Inventor.Nodes
The SoPattern type exposes the following members.
Name | Description | |
---|---|---|
![]() ![]() | AddPattern | Adds a new pattern specified as an array of 128 bytes. |
![]() | AffectsState | Returns true if a node has an effect on the state during traversal. |
![]() | Callback | (Overrides SoNodeCallback(SoCallbackAction).) |
![]() | Copy | Calls Copy(false). (Inherited from SoNode.) |
![]() | Copy(Boolean) | Creates and returns an exact copy of the node. |
![]() | CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
![]() | CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
![]() | Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
![]() | Distribute | (Inherited from SoNode.) |
![]() | DoAction | (Overrides SoNodeDoAction(SoAction).) |
![]() | EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
![]() | Equals | (Inherited from Object.) |
![]() | FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
![]() | Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
![]() | GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
![]() | GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
![]() | GetBoundingBox | (Inherited from SoNode.) |
![]() | GetEventIn | Returns a the eventIn with the given name. |
![]() | GetEventOut | Returns the eventOut with the given name. |
![]() | GetField | Returns a the field of this object whose name is fieldName. |
![]() | GetFieldName | Returns the name of the given field in the fieldName argument. |
![]() | GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
![]() | GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
![]() | GetMatrix | (Inherited from SoNode.) |
![]() | GetName | Returns the name of an instance. |
![]() ![]() | GetPattern(String, String, SbNativeArrayByte) |
Retrieves a pattern bitmap (an array of 128 bytes) specified by its category and name.
the pattern data is read-only.
|
![]() ![]() | GetPattern(String, String, SbNativeByteArray) | Obsolete.
Use generic version of bytes argument instead.
|
![]() ![]() | GetPatternNames(String) |
Gets the names of loaded patterns.
|
![]() ![]() | GetPatternNames(String, String) |
Gets the names of loaded patterns.
|
![]() | GetPrimitiveCount | (Inherited from SoNode.) |
![]() | GetRenderUnitID | (Inherited from SoNode.) |
![]() | GetStringName | (Inherited from SoBase.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GLRender | (Overrides SoNodeGLRender(SoGLRenderAction).) |
![]() | GLRenderBelowPath | (Inherited from SoNode.) |
![]() | GLRenderInPath | (Inherited from SoNode.) |
![]() | GLRenderOffPath | (Inherited from SoNode.) |
![]() | GrabEventsCleanup | (Inherited from SoNode.) |
![]() | GrabEventsSetup | (Inherited from SoNode.) |
![]() | HandleEvent | (Inherited from SoNode.) |
![]() | HasDefaultValues | Returns true if all of the object's fields have their default values. |
![]() | IsBoundingBoxIgnoring | This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. |
![]() | IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
![]() | IsOverride | Returns the state of the override field. |
![]() | IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
![]() ![]() | LoadPatterns(String) | Calls LoadPatterns(fileName, (cli.array<System.String^>^)nullptr, OIV.Inventor.Nodes.SoPattern.FilterTypes( .SoPattern.INCLUSIVE_FILTER )). |
![]() ![]() | LoadPatterns(String, Int32) | Calls LoadPatterns(fileName, numFilters, (cli.array<System.String^>^)nullptr, OIV.Inventor.Nodes.SoPattern.FilterTypes( .SoPattern.INCLUSIVE_FILTER )). |
![]() ![]() | LoadPatterns(String, String) | Calls LoadPatterns(fileName, filterNames, OIV.Inventor.Nodes.SoPattern.FilterTypes( .SoPattern.INCLUSIVE_FILTER )). |
![]() ![]() | LoadPatterns(String, Int32, String) | Calls LoadPatterns(fileName, numFilters, filterNames, OIV.Inventor.Nodes.SoPattern.FilterTypes( .SoPattern.INCLUSIVE_FILTER )). |
![]() ![]() | LoadPatterns(String, String, SoPatternFilterTypes) | Loads a pattern file, with optional filtering of patterns. |
![]() ![]() | LoadPatterns(String, Int32, String, SoPatternFilterTypes) | Loads a pattern file, with optional filtering of patterns. |
![]() | Pick | (Inherited from SoNode.) |
![]() | RayPick | (Inherited from SoNode.) |
![]() | Search | (Inherited from SoNode.) |
![]() | Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
![]() | SetName | (Inherited from SoBase.) |
![]() | SetOverride | Set the state of the override field. |
![]() | SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
![]() | SetToDefaults | Sets all fields in this object to their default values. |
![]() | ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
![]() | Touch | Marks an instance as modified, simulating a change to it. |
![]() | Write | (Inherited from SoNode.) |
Name | Description | |
---|---|---|
![]() | category | Specifies the name of a group of patterns. |
![]() | IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
![]() | name | Specifies the name of a pattern within a category. |
![]() | UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
This node specifies the current pattern for all subsequent shape nodes in a scene graph.
A pattern is a 32x32 bitmap that is interpreted as a mask of 0s and 1s. Where a 1 appears, the corresponding pixel in the polygon is drawn; where a 0 appears, nothing is drawn. Using patterns is like using screendoor transparency where you specify the pattern of the screen. OpenGL polygon stippling is used to render the pattern.
You can load a pattern file containing one or more patterns using the loadPatterns() method. You can also define and load patterns programmatically using the addPattern() method.
Here is a sample showing the pattern file format.
"GEOLOGY" # The first string is the category name of the first pattern. # This is a comment ! "PATTERN N1" # The second string is the name of the pattern. # To define the pattern, you must define a 32x32 sequence of # '1' and '0'. 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 ... #============================================ "PATTERN N2" 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 ...Note:
A pattern file can contain only one category.
There is a potential conflict between the use of screendoor transparency and patterned shapes. If the transparency type is screendoor, transparency is ignored for patterned shapes.
Usage Notes
Patterns can be used for distinguishing, for example, different kinds of rocks in a geologic formation.
The HardCopy extension (formerly known as PlotMaster) allows you to generate resolution-independent vector hardcopy output. It handles patterns but does not handle textures (they are ignored). If you are planning to use the HardCopy extension, you may want to use patterns rather than textures to distinguish different shapes in your scene graph.
Pattern {
category | "" |
name | "" |
NOTE: When you write a pattern node out to a file, the file will not contain enough information to fully reconstruct the original scene graph. The pattern node and its current fields are written out (as expected). However, the current fields only specify a category name and a pattern name. They do not specify the actual pattern(s) (like a typical attribute node) or a filename to get the patterns from (like a texture node).