Coin  4.0.3
Coin3D core library
Loading...
Searching...
No Matches
SoShapeKit Class Reference

The SoShapeKit class provides templates to insert what is usually needed for shape nodes. More...

#include <Inventor/nodekits/SoShapeKit.h>

Inheritance diagram for SoShapeKit:
SoSeparatorKit SoBaseKit SoNode SoFieldContainer SoBase

Public Member Functions

 SoShapeKit (void)
 
virtual const SoNodekitCataloggetNodekitCatalog (void) const
 
virtual SoType getTypeId (void) const
 
- Public Member Functions inherited from SoSeparatorKit
 SoSeparatorKit (void)
 
- Public Member Functions inherited from SoBaseKit
 SoBaseKit (void)
 
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
 
virtual void callback (SoCallbackAction *action)
 
virtual SoNodeKitPathcreatePathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL)
 
virtual void doAction (SoAction *action)
 
SbBool forceChildDrivenWriteRefs (SoOutput *out)
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
virtual SoChildListgetChildren (void) const
 
virtual void getMatrix (SoGetMatrixAction *action)
 
virtual SoNodegetPart (const SbName &partname, SbBool makeifneeded)
 
SbString getPartString (const SoBase *part)
 
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
 
virtual void GLRender (SoGLRenderAction *action)
 
virtual void handleEvent (SoHandleEventAction *action)
 
void printDiagram (void)
 
void printSubDiagram (const SbName &rootname, int level)
 
void printTable (void)
 
virtual void rayPick (SoRayPickAction *action)
 
virtual void search (SoSearchAction *action)
 
SbBool set (const char *namevaluepairliststring)
 
SbBool set (const char *partnamestring, const char *parameterstring)
 
virtual SbBool setPart (const SbName &partname, SoNode *from)
 
virtual void write (SoWriteAction *action)
 
- Public Member Functions inherited from SoNode
virtual SbBool affectsState (void) const
 
virtual void audioRender (SoAudioRenderAction *action)
 
virtual SoNodecopy (SbBool copyconnections=FALSE) const
 
virtual SoFieldContainercopyThroughConnection (void) const
 
SbUniqueId getNodeId (void) const
 
NodeType getNodeType (void) const
 
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 
virtual void GLRenderInPath (SoGLRenderAction *action)
 
virtual void GLRenderOffPath (SoGLRenderAction *action)
 
virtual void grabEventsCleanup (void)
 
virtual void grabEventsSetup (void)
 
SbBool isOverride (void) const
 
virtual void notify (SoNotList *l)
 
virtual void pick (SoPickAction *action)
 
void setNodeType (const NodeType type)
 
void setOverride (const SbBool state)
 
virtual void startNotify (void)
 
virtual void writeInstance (SoOutput *out)
 
- Public Member Functions inherited from SoFieldContainer
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
 
SbBool enableNotify (const SbBool flag)
 
SbBool fieldsAreEqual (const SoFieldContainer *container) const
 
void get (SbString &fielddata)
 
void get (SbString &fielddata, SoOutput *out)
 
virtual int getAllFields (SoFieldList &l) const
 
virtual SoFieldgetEventIn (const SbName &name) const
 
virtual SoFieldgetEventOut (const SbName &name) const
 
virtual SoFieldgetField (const SbName &name) const
 
SbBool getFieldName (const SoField *const field, SbName &name) const
 
virtual int getFields (SoFieldList &l) const
 
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
 
SbBool getIsBuiltIn (void) const
 
voidgetUserData (void) const
 
SbBool hasDefaultValues (void) const
 
SbBool isNotifyEnabled (void) const
 
SbBool set (const char *const fielddata)
 
SbBool set (const char *fielddata, SoInput *input)
 
void setToDefaults (void)
 
void setUserData (void *userdata) const
 
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
 
- Public Member Functions inherited from SoBase
void addAuditor (void *const auditor, const SoNotRec::Type type)
 
void assertAlive (void) const
 
const SoAuditorListgetAuditors (void) const
 
virtual SbName getName (void) const
 
int32_t getRefCount (void) const
 
SbBool isOfType (SoType type) const
 Returns TRUE if the type of this object is either of the same type or inherited from type.
 
void ref (void) const
 
void removeAuditor (void *const auditor, const SoNotRec::Type type)
 
virtual void setName (const SbName &newname)
 
SbBool shouldWrite (void)
 
void touch (void)
 
void unref (void) const
 
void unrefNoDelete (void) const
 

Static Public Member Functions

static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoSeparatorKit
static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoBaseKit
static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 
static SbBool isSearchingChildren (void)
 
static void setSearchingChildren (const SbBool newval)
 
- Static Public Member Functions inherited from SoNode
static void audioRenderS (SoAction *action, SoNode *node)
 
static void callbackS (SoAction *action, SoNode *node)
 
static int getActionMethodIndex (const SoType type)
 
static void getBoundingBoxS (SoAction *action, SoNode *node)
 
static SoNodegetByName (const SbName &name)
 
static int getByName (const SbName &name, SoNodeList &l)
 
static SoType getClassTypeId (void)
 
static uint32_t getCompatibilityTypes (const SoType &nodetype)
 
static void getMatrixS (SoAction *action, SoNode *node)
 
static SbUniqueId getNextNodeId (void)
 
static void getPrimitiveCountS (SoAction *action, SoNode *node)
 
static void GLRenderS (SoAction *action, SoNode *node)
 
static void handleEventS (SoAction *action, SoNode *node)
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static void initClasses (void)
 
static void pickS (SoAction *action, SoNode *node)
 
static void rayPickS (SoAction *action, SoNode *node)
 
static void searchS (SoAction *action, SoNode *node)
 
static void writeS (SoAction *action, SoNode *node)
 
- Static Public Member Functions inherited from SoFieldContainer
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 
static void cleanupClass (void)
 
static void copyDone (void)
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, const SbBool copyconnections)
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static void initCopyDict (void)
 
- Static Public Member Functions inherited from SoBase
static void addName (SoBase *const base, const char *const name)
 
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
 
static void decrementCurrentWriteCounter (void)
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static SoBasegetNamedBase (const SbName &name, SoType type)
 
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
 
static SbBool getTraceRefs (void)
 
static void incrementCurrentWriteCounter (void)
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
 
static SbBool readRoute (SoInput *input)
 
static void removeName (SoBase *const base, const char *const name)
 
static void setInstancePrefix (const SbString &c)
 
static void setTraceRefs (SbBool trace)
 

Protected Member Functions

virtual ~SoShapeKit ()
 
virtual const SoFieldDatagetFieldData (void) const
 
virtual void setDefaultOnNonWritingFields (void)
 
- Protected Member Functions inherited from SoSeparatorKit
virtual ~SoSeparatorKit ()
 
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
 
- Protected Member Functions inherited from SoBaseKit
virtual ~SoBaseKit ()
 
virtual SoNodeaddToCopyDict (void) const
 
void catalogError (void)
 
virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
 
void countMyFields (SoOutput *out)
 
virtual void createDefaultParts (void)
 
void createFieldList (void)
 
void createNodekitPartsList (void)
 
virtual SoNodeKitPathcreatePathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL)
 
virtual SoNodegetAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
 
const SbList< SoSFNode * > & getCatalogInstances (void) const
 
SoGroupgetContainerNode (const SbName &listname, SbBool makeifneeded=TRUE)
 
const SoNodekitPartsgetNodekitPartsList (void) const
 
virtual SbBool readInstance (SoInput *in, unsigned short flags)
 
virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE)
 
virtual SbBool setPart (const int partNum, SoNode *node)
 
- Protected Member Functions inherited from SoNode
 SoNode (void)
 
virtual ~SoNode ()
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
 
virtual ~SoFieldContainer ()
 
- Protected Member Functions inherited from SoBase
 SoBase (void)
 
virtual ~SoBase ()
 
virtual SoNotRec createNotRec (void)
 
virtual void destroy (void)
 
virtual const char * getFileFormatName (void) const
 
SbBool hasMultipleWriteRefs (void) const
 
void writeFooter (SoOutput *out) const
 
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
 

Static Protected Member Functions

static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
 
static const SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoSeparatorKit
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
 
static const SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoBaseKit
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
 
static const SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr (void)
 
static int getNextActionMethodIndex (void)
 
static void incNextActionMethodIndex (void)
 
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)
 
static void setNextActionMethodIndex (int index)
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter (void)
 
static void staticDataLock (void)
 
static void staticDataUnlock (void)
 

Protected Attributes

SoSFNode coordinate3
 
SoSFNode coordinate4
 
SoSFNode localTransform
 
SoSFNode materialBinding
 
SoSFNode normal
 
SoSFNode normalBinding
 
SoSFNode profileCoordinate2
 
SoSFNode profileCoordinate3
 
SoSFNode profileList
 
SoSFNode shape
 
SoSFNode shapeHints
 
SoSFNode shapeSeparator
 
SoSFNode textureCoordinate2
 
SoSFNode textureCoordinateBinding
 
SoSFNode textureCoordinateFunction
 
- Protected Attributes inherited from SoSeparatorKit
SoSFNode appearance
 
SoSFNode childList
 
SoSFNode pickStyle
 
SoSFNode texture2Transform
 
SoSFNode topSeparator
 
SoSFNode transform
 
SoSFNode units
 
- Protected Attributes inherited from SoBaseKit
SoSFNode callbackList
 
SoChildListchildren
 
SbBool connectionsSetUp
 
- Protected Attributes inherited from SoNode
SbUniqueId uniqueId
 
- Protected Attributes inherited from SoFieldContainer
SbBool isBuiltIn
 

Additional Inherited Members

- Public Types inherited from SoSeparatorKit
enum  CacheEnabled { OFF , ON , AUTO }
 
- Public Types inherited from SoNode
enum  NodeType {
  INVENTOR = 0x0000 , VRML1 = 0x0001 , VRML2 = 0x0002 , INVENTOR_1 = 0x0004 ,
  INVENTOR_2_0 = 0x0008 , INVENTOR_2_1 = 0x0010 , INVENTOR_2_5 = 0x0020 , INVENTOR_2_6 = 0x0040 ,
  COIN_1_0 = 0x0080 , COIN_2_0 = 0x0100 , EXTENSION = 0x0200 , COIN_2_2 = 0x0400 ,
  COIN_2_3 = 0x0800 , COIN_2_4 = 0x1000 , INVENTOR_5_0 = 0x2000 , COIN_2_5 = 0x4000 ,
  COIN_3_0 = 0x8000 , INVENTOR_6_0 = 0x10000 , COIN_4_0 = 0x20000
}
 
- Public Attributes inherited from SoSeparatorKit
SoSFEnum boundingBoxCaching
 
SoSFEnum pickCulling
 
SoSFEnum renderCaching
 
SoSFEnum renderCulling
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 }
 
- Static Protected Attributes inherited from SoNode
static int nextActionMethodIndex = 0
 
static SbUniqueId nextUniqueId = 1
 

Detailed Description

The SoShapeKit class provides templates to insert what is usually needed for shape nodes.

Nodekit structure (new entries versus parent class marked with arrow prefix):

CLASS SoShapeKit
-->"this"
      "callbackList"
      "topSeparator"
         "pickStyle"
         "appearance"
         "units"
         "transform"
         "texture2Transform"
-->      "materialBinding"
-->      "normalBinding"
-->      "textureCoordinateBinding"
-->      "shapeHints"
-->      "coordinate3"
-->      "coordinate4"
-->      "normal"
-->      "textureCoordinate2"
-->      "profileCoordinate2"
-->      "profileCoordinate3"
-->      "profileList"
         "childList"
-->      "textureCoordinateFunction"
-->      "localTransform"
-->      "shapeSeparator"
-->         "shape"

(See SoBaseKit::printDiagram() for information about the output formatting.)

Detailed information on catalog parts:

CLASS SoShapeKit
PVT   "this",  SoShapeKit  --- 
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ] 
PVT   "topSeparator",  SoSeparator  --- 
      "pickStyle",  SoPickStyle  --- 
      "appearance",  SoAppearanceKit  --- 
      "units",  SoUnits  --- 
      "transform",  SoTransform  --- 
      "texture2Transform",  SoTexture2Transform  --- 
      "materialBinding",  SoMaterialBinding  --- 
      "normalBinding",  SoNormalBinding  --- 
      "textureCoordinateBinding",  SoTextureCoordinateBinding  --- 
      "shapeHints",  SoShapeHints  --- 
      "coordinate3",  SoCoordinate3  --- 
      "coordinate4",  SoCoordinate4  --- 
      "normal",  SoNormal  --- 
      "textureCoordinate2",  SoTextureCoordinate2  --- 
      "profileCoordinate2",  SoProfileCoordinate2  --- 
      "profileCoordinate3",  SoProfileCoordinate3  --- 
      "profileList",  SoNodeKitListPart [ SoProfile ] 
      "childList",  SoNodeKitListPart [ SoShapeKit, SoSeparatorKit ] 
      "textureCoordinateFunction",  SoTextureCoordinateFunction  --- , (default type = SoTextureCoordinateDefault)
      "localTransform",  SoTransform  --- 
PVT   "shapeSeparator",  SoSeparator  --- 
      "shape",  SoShape  --- , (default type = SoCube)

(See SoBaseKit::printTable() for information about the output formatting.)

Constructor & Destructor Documentation

◆ SoShapeKit()

SoShapeKit::SoShapeKit ( void )

Constructor.

◆ ~SoShapeKit()

SoShapeKit::~SoShapeKit ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ getClassNodekitCatalog()

const SoNodekitCatalog * SoShapeKit::getClassNodekitCatalog ( void )
static

Returns the nodekit catalog which defines the layout of this class' kit.

◆ getClassNodekitCatalogPtr()

const SoNodekitCatalog ** SoShapeKit::getClassNodekitCatalogPtr ( void )
staticprotected

Returns the pointer to the pointer of the nodekit catalog for this class.

◆ getClassTypeId()

SoType SoShapeKit::getClassTypeId ( void )
static

This static method returns the SoType object associated with objects of this class.

◆ getFieldData()

const SoFieldData * SoShapeKit::getFieldData ( void ) const
protectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoSeparatorKit.

◆ getFieldDataPtr()

const SoFieldData ** SoShapeKit::getFieldDataPtr ( void )
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Returns the SoFieldData class which holds information about fields in this node.

◆ getNodekitCatalog()

const SoNodekitCatalog * SoShapeKit::getNodekitCatalog ( void ) const
virtual

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoSeparatorKit.

◆ getTypeId()

SoType SoShapeKit::getTypeId ( void ) const
virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Reimplemented from SoSeparatorKit.

◆ initClass()

void SoShapeKit::initClass ( void )
static

◆ setDefaultOnNonWritingFields()

void SoShapeKit::setDefaultOnNonWritingFields ( void )
protectedvirtual

(Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. If you indeed are writing extensions, see the information in the SoBaseKit class documentation.)

This is a virtual method, and the code in it should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scene graph export operations.

This is typically done when:

  1. field value is NULL and part is NULL by default

  2. it is a leaf SoGroup or SoSeparator node with no children

  3. it is a leaf listpart with no children and an SoGroup or SoSeparator container

  4. it is a non-leaf part and it is of SoGroup type and all fields are at their default values

Subclasses should usually override this to do additional settings for new member fields. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method.

Reimplemented from SoSeparatorKit.


The documentation for this class was generated from the following files: