GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOSHAPEKIT (3)

NAME

SoShapeKit — shape nodekit class

CONTENTS

Inherits From
Synopsis
Description
Parts
Methods
Catalog Parts
File Format/defaults
See Also

INHERITS FROM

SoBase > SoFieldContainer > SoNode > SoBaseKit > SoSeparatorKit > SoShapeKit

SYNOPSIS

#include <Inventor/nodekits/SoShapeKit.h>

Fields from class SoSeparatorKit:

    SoSFEnum    
                    
SoSFEnum             renderCaching    
SoSFEnum    
                    
SoSFEnum             boundingBoxCaching    
SoSFEnum    
                    
SoSFEnum             renderCulling    
SoSFEnum    
                    
SoSFEnum             pickCulling

Parts from class SoShapeKit:

    (SoSeparator)    
                        
(SoSeparator)            shapeSeparator    
(SoMaterialBinding)    
                        
(SoMaterialBinding)      materialBinding    
(SoNormalBinding)    
                        
(SoNormalBinding)        normalBinding    
(SoTextureCoordinateBinding)    
                        
(SoTextureCoordinateBinding) textureCoordinateBinding    
(SoShapeHints)    
                        
(SoShapeHints)           shapeHints    
(SoCoordinate3)    
                        
(SoCoordinate3)          coordinate3    
(SoCoordinate4)    
                        
(SoCoordinate4)          coordinate4    
(SoNormal)    
                        
(SoNormal)               normal    
(SoTextureCoordinate2)    
                        
(SoTextureCoordinate2)   textureCoordinate2    
(SoTextureCoordinateFunction)    
                        
(SoTextureCoordinateFunction) textureCoordinateFunction    
(SoProfileCoordinate2)    
                        
(SoProfileCoordinate2)   profileCoordinate2    
(SoProfileCoordinate3)    
                        
(SoProfileCoordinate3)   profileCoordinate3    
(SoNodeKitListPart)    
                        
(SoNodeKitListPart)      profileList    
(SoTransform)    
                        
(SoTransform)            localTransform    
(SoShape)    
                        
(SoShape)                shape

Parts from class SoSeparatorKit:

    (SoPickStyle)    
                       
(SoPickStyle)           pickStyle    
(SoAppearanceKit)    
                       
(SoAppearanceKit)       appearance    
(SoUnits)    
                       
(SoUnits)               units    
(SoTransform)    
                       
(SoTransform)           transform    
(SoTexture2Transform)    
                       
(SoTexture2Transform)   texture2Transform    
(SoNodeKitListPart)    
                       
(SoNodeKitListPart)     childList

Parts from class SoBaseKit:

    (SoNodeKitListPart)    
                     
(SoNodeKitListPart)   callbackList

Methods from class SoShapeKit:

       
                    
                     SoShapeKit()    
static const SoNodekitCatalog *    
                    
static const SoNodekitCatalog * getClassNodekitCatalog() const    
static SoType    
                    
static SoType        getClassTypeId()

Methods from class SoBaseKit:

    virtual const SoNodekitCatalog *    
                         
virtual const SoNodekitCatalog * getNodekitCatalog() const    
virtual SoNode *    
                         
virtual SoNode *          getPart(const SbName &partName, SbBool makeIfNeeded)    
SbString    
                         
SbString                  getPartString(const SoBase *part)    
virtual SoNodeKitPath *    
                         
virtual SoNodeKitPath *   createPathToPart(const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend = NULL)    
virtual SbBool    
                         
virtual SbBool            setPart(const SbName &partName, SoNode *newPart)    
SbBool    
                         
SbBool                    set(char *partName, char *parameters)    
SbBool    
                         
SbBool                    set(char *nameValuePairs)    
static SbBool    
                         
static SbBool             isSearchingChildren()    
static void    
                         
static void               setSearchingChildren(SbBool newVal)

Methods from class SoNode:

    void    
                    
void                 setOverride(SbBool state)    
SbBool    
                    
SbBool               isOverride() const    
SoNode *    
                    
SoNode *             copy(SbBool copyConnections = FALSE) const    
virtual SbBool    
                    
virtual SbBool       affectsState() const    
static SoNode *    
                    
static SoNode *      getByName(const SbName &name)    
static int    
                    
static int           getByName(const SbName &name, SoNodeList &list)

Methods from class SoFieldContainer:

    void    
                    
void                 setToDefaults()    
SbBool    
                    
SbBool               hasDefaultValues() const    
SbBool    
                    
SbBool               fieldsAreEqual(const SoFieldContainer *fc) const    
void    
                    
void                 copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)    
void    
                    
void                 get(SbString &fieldDataString)    
virtual int    
                    
virtual int          getFields(SoFieldList &resultList) const    
virtual SoField *    
                    
virtual SoField *    getField(const SbName &fieldName) const    
SbBool    
                    
SbBool               getFieldName(const SoField *field, SbName &fieldName) const    
SbBool    
                    
SbBool               isNotifyEnabled() const    
SbBool    
                    
SbBool               enableNotify(SbBool flag)

Methods from class SoBase:

    void    
                    
void                 ref()    
void    
                    
void                 unref() const    
void    
                    
void                 unrefNoDelete() const    
void    
                    
void                 touch()    
virtual SoType    
                    
virtual SoType       getTypeId() const    
SbBool    
                    
SbBool               isOfType(SoType type) const    
virtual void    
                    
virtual void         setName(const SbName &name)    
virtual SbName    
                    
virtual SbName       getName() const

Macros from class SoBaseKit:

SO_GET_PART(kit, partName, partClass)
                    
SO_CHECK_PART(kit, partName, partClass)
                    

DESCRIPTION

A nodekit that is used for creating a shape (i.e. geometry). SoShapeKit is derived from SoSeparatorKit and SoBaseKit, and thus inherits all the parts defined by these classes.

Furthermore, 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 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 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 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.

PARTS

    (SoSeparator)    
                        
(SoSeparator)            shapeSeparator
This is a private part. The parent node of the actual shape part. It is a SoSeparator and is NULL by default, but is created automatically if necessary.

    (SoMaterialBinding)    
                        
(SoMaterialBinding)      materialBinding
An 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.

    (SoNormalBinding)    
                        
(SoNormalBinding)        normalBinding
An 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.

    (SoTextureCoordinateBinding)    
                        
(SoTextureCoordinateBinding) textureCoordinateBinding
An 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.

    (SoShapeHints)    
                        
(SoShapeHints)           shapeHints
An 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.

    (SoCoordinate3)    
                        
(SoCoordinate3)          coordinate3
An 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.

    (SoCoordinate4)    
                        
(SoCoordinate4)          coordinate4
An 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.

    (SoNormal)    
                        
(SoNormal)               normal
An 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.

    (SoTextureCoordinate2)    
                        
(SoTextureCoordinate2)   textureCoordinate2
An 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.

    (SoTextureCoordinateFunction)    
                        
(SoTextureCoordinateFunction) textureCoordinateFunction
An 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.

    (SoProfileCoordinate2)    
                        
(SoProfileCoordinate2)   profileCoordinate2
An SoProfileCoordinate2 node that can be used to set the 2D profile coordinates for a shape that uses them, (e.g., SoText3). This part is NULL by default, but is created automatically if necessary.

    (SoProfileCoordinate3)    
                        
(SoProfileCoordinate3)   profileCoordinate3
An SoProfileCoordinate3 node that can be used to set the 3D profile coordinates for a shape that uses them, (e.g., SoSoNURBSCurve). This part is NULL by default, but is created automatically if necessary.

    (SoNodeKitListPart)    
                        
(SoNodeKitListPart)      profileList
An SoProfileList node that can be used to set the profile curve for a shape that uses them, (e.g., SoNurbsCurve). This part is NULL by default, but is created automatically if necessary.

    (SoTransform)    
                        
(SoTransform)            localTransform
An SoTransform node that can be used to set a local tranformation on the shape. This part is NULL by default, but is created automatically if necessary.

    (SoShape)    
                        
(SoShape)                shape
This is the part which specifies the actual shape node. This can be any node derived from SoShape By default, an SoCube is created. It is important to set all of the appropriate parts within this nodekit to suit the type of SoShape that is used. For example, if the shape part is set to an 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.

METHODS

       
                    
                     SoShapeKit()
Constructor.

    static const SoNodekitCatalog *    
                    
static const SoNodekitCatalog * getClassNodekitCatalog() const
Returns an SoNodekitCatalog for the class SoShapeKit.

    static SoType    
                    
static SoType        getClassTypeId()
Returns type identifier for this class.

CATALOG PARTS

All parts
   NULL by
Part NamePart TypeDefault TypeDefault
callbackListNodeKitListPart--yes
pickStylePickStyle--yes
appearanceAppearanceKit--yes
unitsUnits--yes
transformTransform--yes
texture2TransformTexture2Transform--yes
childListNodeKitListPart--yes
materialBindingMaterialBinding--yes
normalBindingNormalBinding--yes
textureCoordinateBindingTextureCoordinateBinding--yes
shapeHintsShapeHints--yes
coordinate3Coordinate3--yes
coordinate4Coordinate4--yes
normalNormal--yes
textureCoordinate2TextureCoordinate2--yes
textureCoordinateFunctionTextureCoordinateFunctionTextureCoordinateDefaultyes
profileCoordinate2ProfileCoordinate2--yes
profileCoordinate3ProfileCoordinate3--yes
profileListNodeKitListPart--yes
localTransformTransform--yes
shapeShapeCubeno

Extra information for list parts from above table
Part NameContainer TypePermissible Types 
callbackListSeparatorCallback, EventCallback
childListSeparatorShapeKit, SeparatorKit
profileListGroupProfile

FILE FORMAT/DEFAULTS

ShapeKit {



renderCaching              AUTO
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 {
}

}

SEE ALSO

SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog, SoSceneKit, SoSeparatorKit, SoWrapperKit, SoCone, SoCube, SoCylinder, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoNurbsCurve, SoNurbsSurface, SoShapeHints, SoSphere, SoText2, SoText3, SoVertexShape

Search for    or go to Top of page |  Section 3 |  Main Index


SOSHAPEKIT(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.