SoShapeKit Class |
Shape nodekit class.
Namespace: OIV.Inventor.Nodekits
The SoShapeKit type exposes the following members.
Name | Description | |
---|---|---|
SoShapeKit | Constructor. |
Name | Description | |
---|---|---|
AffectsState | Returns true if a node has an effect on the state during traversal. | |
Callback | (Inherited from SoBaseKit.) | |
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. | |
CreatePathToPart(String, Boolean) | Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr). (Inherited from SoBaseKit.) | |
CreatePathToPart(String, Boolean, SoPath) | Returns a path that begins at this nodekit and ends at partName. | |
Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) | |
Distribute | (Inherited from SoNode.) | |
DoAction | (Inherited from SoBaseKit.) | |
EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). | |
Equals | Determines whether the specified Object is equal to the current Object. (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 SoBaseKit.) | |
GetClassNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class. | |
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 SoBaseKit.) | |
GetName | Returns the name of an instance. | |
GetNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. | |
GetPart | Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. | |
GetPartString | Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part. | |
GetPrimitiveCount | (Inherited from SoBaseKit.) | |
GetRenderEngineMode | Returns the supported Render engine mode. | |
GetRenderUnitID | (Inherited from SoNode.) | |
GetStringName | (Inherited from SoBase.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetViewportIsEnabled | (Inherited from SoBaseKit.) | |
GetViewportOrigin | (Inherited from SoBaseKit.) | |
GetViewportSize | (Inherited from SoBaseKit.) | |
GLRender | (Inherited from SoBaseKit.) | |
GLRenderBelowPath | (Inherited from SoNode.) | |
GLRenderInPath | (Inherited from SoNode.) | |
GLRenderOffPath | (Inherited from SoNode.) | |
GrabEventsCleanup | (Inherited from SoNode.) | |
GrabEventsSetup | (Inherited from SoNode.) | |
HandleEvent | (Inherited from SoBaseKit.) | |
HasDefaultValues | Returns true if all of the object's fields have their default values. | |
IsBoundingBoxIgnoring | Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. | |
IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. | |
IsOverride | Returns the state of the override flag. | |
IsSynchronizable | Gets the ScaleViz synchronizable state of this object. | |
Pick | (Inherited from SoNode.) | |
RayPick | (Inherited from SoBaseKit.) | |
Search | (Inherited from SoBaseKit.) | |
Set(String) | This function allows field values of parts (nodes) to be set in several different parts simultaneously. | |
Set(String, String) | This function allows field values of parts (nodes) to be set. | |
SetName | (Inherited from SoBase.) | |
SetOverride | Turns the override flag on or off. | |
SetPart | Inserts the given node (not a copy) as the new part specified by partName. | |
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 SoBaseKit.) |
Name | Description | |
---|---|---|
boundingBoxCaching | (Inherited from SoSeparatorKit.) | |
boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
pickCulling | Set pick culling mode. | |
renderCaching | Obsolete. Set render caching mode. | |
renderCulling | Set render culling mode. | |
UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
A nodekit that is used for creating a shape (i.e. geometry). OIV.Inventor.Nodekits.SoShapeKit is derived from OIV.Inventor.Nodekits.SoSeparatorKit and OIV.Inventor.Nodekits.SoBaseKit, and thus inherits all the parts defined by these classes.
Furthermore, OIV.Inventor.Nodekits.SoShapeKit adds numerous parts that can be used to define a variety of shape objects, a localTransform part, and of course a shape part.
All of the property nodes requires to define any of the Open Inventor shapes are included as parts in this class. Not all of these parts (nodes) are needed for any one type of shape. For example, if you set the shape part to be an OIV.Inventor.Nodes.SoSphere node, then it is not necessary to create a profileCoordinate3 part since it will be ignored in drawing the sphere. (And the unneeded parts will not be created, so there is no performance penalty for using this class of node.
This class contains two private parts. They are both OIV.Inventor.Nodes.SoSeparator nodes. One of them sits just below the nodekit itself, and serves to contain all properties within this nodekit from affecting nodes that come after this nodekit. The second separator sits above the shape part, and serves to cache the shape even when the transform , localTransform , or appearance parts are changing.
(OIV.Inventor.Nodes.SoSeparator) shapeSeparator This is a private part. The parent node of the actual shape part. It is an OIV.Inventor.Nodes.SoSeparator and is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoMaterialBinding) materialBinding An OIV.Inventor.Nodes.SoMaterialBinding node that can be used to set the material binding for the shape. This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoNormalBinding) normalBinding An OIV.Inventor.Nodes.SoNormalBinding node that can be used to set the normal binding for the shape. This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoTextureCoordinateBinding) textureCoordinateBinding An OIV.Inventor.Nodes.SoTextureCoordinateBinding node that can be used to set the texture coordinate binding for the shape. This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoShapeHints) shapeHints An OIV.Inventor.Nodes.SoShapeHints node that can be used to set the shape hints for the shape. This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoCoordinate3) coordinate3 An OIV.Inventor.Nodes.SoCoordinate3 node that can be used to set the 3D coordinates for a vertex-based shape. This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoCoordinate4) coordinate4 An OIV.Inventor.Nodes.SoCoordinate4 node that can be used to set the 4D coordinates for a NURBS shapes. This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoNormal) normal An OIV.Inventor.Nodes.SoNormal node that can be used to set the normal vectors for a vertex-based shape. This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoTextureCoordinate2) textureCoordinate2 An OIV.Inventor.Nodes.SoTextureCoordinate2 node that can be used to set the texture coordinates for a vertex-based shape. This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoTextureCoordinateFunction) textureCoordinateFunction An OIV.Inventor.Nodes.SoTextureCoordinateFunction node that can be used to set the a procedural texture coordinates function for a vertex-based shape. This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoProfileCoordinate2) profileCoordinate2 An OIV.Inventor.Nodes.SoProfileCoordinate2 node that can be used to set the 2D profile coordinates for a shape that uses them, (e.g., OIV.Inventor.Nodes.SoText3). This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoProfileCoordinate3) profileCoordinate3 An OIV.Inventor.Nodes.SoProfileCoordinate3 node that can be used to set the 3D profile coordinates for a shape that uses them, (e.g., OIV.Inventor.Nodes.SoNurbsCurve). This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodekits.SoNodeKitListPart) profileList An SoProfileList node that can be used to set the profile curve for a shape that uses them, (e.g., OIV.Inventor.Nodes.SoNurbsCurve). This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoTransform) localTransform An OIV.Inventor.Nodes.SoTransform node that can be used to set a local transformation on the shape. This part is NULL by default, but is created automatically if necessary.
(OIV.Inventor.Nodes.SoShape) shape This is the part which specifies the actual shape node. This can be any node derived from OIV.Inventor.Nodes.SoShape By default, an OIV.Inventor.Nodes.SoCube is created. It is important to set all of the appropriate parts within this nodekit to suit the type of OIV.Inventor.Nodes.SoShape that is used. For example, if the shape part is set to an OIV.Inventor.Nodes.SoFaceSet, then the coordinate3 shape and probably the normal shape would be set as well. See the reference page of the shape used for details on which other nodes are necessary.
ShapeKit {
boundingBoxCaching | AUTO |
renderCulling | AUTO |
pickCulling | AUTO |
callbackList | NULL |
pickStyle | NULL |
appearance | NULL |
units | NULL |
transform | NULL |
texture2Transform | NULL |
childList | NULL |
materialBinding | NULL |
normalBinding | NULL |
textureCoordinateBinding | NULL |
shapeHints | NULL |
coordinate3 | NULL |
coordinate4 | NULL |
normal | NULL |
textureCoordinate2 | NULL |
textureCoordinateFunction | NULL |
profileCoordinate2 | NULL |
profileCoordinate3 | NULL |
profileList | NULL |
localTransform | NULL |
shape | Cube { |
} |
All Parts
Part Name | Part Type | Default Type | NULL Default |
callbackList | NodeKitListPart | yes | |
pickStyle | PickStyle | yes | |
appearance | AppearanceKit | yes | |
units | Units | yes | |
transform | Transform | yes | |
texture2Transform | Texture2Transform | yes | |
childList | NodeKitListPart | yes | |
materialBinding | MaterialBinding | yes | |
normalBinding | NormalBinding | yes | |
textureCoordinate- Binding | TextureCoordinateBinding | yes | |
shapeHints | ShapeHints | yes | |
coordinate3 | Coordinate3 | yes | |
coordinate4 | Coordinate4 | yes | |
normal | Normal | yes | |
textureCoordinate2 | TextureCoordinate2 | yes | |
textureCoordinate- Function | TextureCoordinateFunction | Texture Coordinate Default | yes |
profileCoordinate2 | ProfileCoordinate2 | yes | |
profileCoordinate3 | ProfileCoordinate3 | yes | |
profileList | NodeKitListPart | yes | |
localTransform | Transform | yes | |
shape | Shape | Cube | no |
Extra Information for List Parts from Above Table
Part Name | Container Type | Possible Types |
callbackList | Separator | Callback, EventCallback |