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

The SoVRMLVertexShape class is a superclass for vertex based shapes. More...

#include <Inventor/VRMLnodes/SoVRMLVertexShape.h>

Inheritance diagram for SoVRMLVertexShape:
SoVRMLGeometry SoShape SoNode SoFieldContainer SoBase SoVRMLIndexedShape SoVRMLIndexedFaceSet

Public Types

enum  Binding {
  OVERALL = SoMaterialBindingElement::OVERALL , PER_PART = SoMaterialBindingElement::PER_PART , PER_PART_INDEXED = SoMaterialBindingElement::PER_PART_INDEXED , PER_FACE = SoMaterialBindingElement::PER_FACE ,
  PER_FACE_INDEXED = SoMaterialBindingElement::PER_FACE_INDEXED , PER_VERTEX = SoMaterialBindingElement::PER_VERTEX , PER_VERTEX_INDEXED = SoMaterialBindingElement::PER_VERTEX_INDEXED
}
 
- Public Types inherited from SoShape
enum  TriangleShape {
  TRIANGLE_STRIP , TRIANGLE_FAN , TRIANGLES , POLYGON ,
  QUADS , QUAD_STRIP , POINTS , LINES ,
  LINE_STRIP
}
 
- 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 Member Functions

virtual void callback (SoCallbackAction *action)
 
virtual void doAction (SoAction *action)
 
virtual SbBool generateDefaultNormals (SoState *s, SoNormalBundle *nb)
 
virtual SbBool generateDefaultNormals (SoState *s, SoNormalCache *nc)
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
virtual SoType getTypeId (void) const
 
virtual void GLRender (SoGLRenderAction *action)
 
virtual void notify (SoNotList *list)
 
virtual void pick (SoPickAction *action)
 
- Public Member Functions inherited from SoVRMLGeometry
virtual void copyContents (const SoFieldContainer *from, SbBool copyConn)
 
virtual void search (SoSearchAction *action)
 
- Public Member Functions inherited from SoShape
virtual SbBool affectsState (void) const
 
virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)=0
 
const SoBoundingBoxCachegetBoundingBoxCache (void) const
 
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
 
virtual void rayPick (SoRayPickAction *action)
 
- Public Member Functions inherited from SoNode
virtual SoNodeaddToCopyDict (void) const
 
virtual void audioRender (SoAudioRenderAction *action)
 
virtual SoNodecopy (SbBool copyconnections=FALSE) const
 
virtual SoFieldContainercopyThroughConnection (void) const
 
virtual void getMatrix (SoGetMatrixAction *action)
 
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)
 
virtual void handleEvent (SoHandleEventAction *action)
 
SbBool isOverride (void) const
 
void setNodeType (const NodeType type)
 
void setOverride (const SbBool state)
 
virtual void startNotify (void)
 
virtual void write (SoWriteAction *action)
 
virtual void writeInstance (SoOutput *out)
 
- Public Member Functions inherited from SoFieldContainer
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
 
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 SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoVRMLGeometry
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoShape
static SoType getClassTypeId (void)
 
static float getDecimatedComplexity (SoState *state, float complexity)
 
static void getScreenSize (SoState *const state, const SbBox3f &boundingbox, SbVec2s &rectsize)
 
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 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)
 

Public Attributes

SoSFNode color
 
SoSFBool colorPerVertex
 
SoSFNode coord
 
SoSFNode normal
 
SoSFBool normalPerVertex
 
SoSFNode texCoord
 

Protected Member Functions

 SoVRMLVertexShape (void)
 
virtual ~SoVRMLVertexShape ()
 
SoNormalCachegenerateAndReadLockNormalCache (SoState *const state)
 
virtual const SoFieldDatagetFieldData (void) const
 
SoNormalCachegetNormalCache (void) const
 
void getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const SbBool neednormals)
 
void readLockNormalCache (void)
 
void readUnlockNormalCache (void)
 
void setNormalCache (SoState *s, int numNormals, SbVec3f *normals)
 
virtual SbBool shouldGLRender (SoGLRenderAction *action)
 
- Protected Member Functions inherited from SoVRMLGeometry
 SoVRMLGeometry (void)
 
virtual ~SoVRMLGeometry ()
 
virtual SoChildListgetChildren (void) const
 
void setupShapeHints (SoState *state, const SbBool ccw, const SbBool solid)
 
- Protected Member Functions inherited from SoShape
 SoShape (void)
 
virtual ~SoShape ()
 
void beginShape (SoAction *const action, const TriangleShape shapetype, SoDetail *const detail=NULL)
 
void beginSolidShape (SoGLRenderAction *action)
 
void computeObjectSpaceRay (SoRayPickAction *const action)
 
void computeObjectSpaceRay (SoRayPickAction *const action, const SbMatrix &matrix)
 
virtual SoDetailcreateLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp)
 
virtual SoDetailcreatePointDetail (SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp)
 
virtual SoDetailcreateTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp)
 
void endShape (void)
 
void endSolidShape (SoGLRenderAction *action)
 
void finishVertexArray (SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex)
 
virtual void generatePrimitives (SoAction *action)=0
 
void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoMultiTextureCoordinateElement *const tce, const float s, const float t, const float r, const SbVec3f &normal)
 
void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoMultiTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal)
 
float getComplexityValue (SoAction *action)
 
void GLRenderBoundingBox (SoGLRenderAction *action)
 
void invokeLineSegmentCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2)
 
void invokePointCallbacks (SoAction *const action, const SoPrimitiveVertex *const v)
 
void invokeTriangleCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3)
 
void shapeVertex (const SoPrimitiveVertex *const v)
 
SbBool shouldPrimitiveCount (SoGetPrimitiveCountAction *action)
 
SbBool shouldRayPick (SoRayPickAction *const action)
 
SbBool startVertexArray (SoGLRenderAction *action, const SoCoordinateElement *coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex)
 
- Protected Member Functions inherited from SoNode
 SoNode (void)
 
virtual ~SoNode ()
 
virtual SbBool readInstance (SoInput *in, unsigned short flags)
 
- 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 SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoVRMLGeometry
static const SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoShape
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)
 

Additional Inherited Members

- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 }
 
- Protected Attributes inherited from SoNode
SbUniqueId uniqueId
 
- Protected Attributes inherited from SoFieldContainer
SbBool isBuiltIn
 
- Static Protected Attributes inherited from SoNode
static int nextActionMethodIndex = 0
 
static SbUniqueId nextUniqueId = 1
 

Detailed Description

The SoVRMLVertexShape class is a superclass for vertex based shapes.

Constructor & Destructor Documentation

◆ SoVRMLVertexShape()

SoVRMLVertexShape::SoVRMLVertexShape ( void )
protected

Constructor.

◆ ~SoVRMLVertexShape()

SoVRMLVertexShape::~SoVRMLVertexShape ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ callback()

void SoVRMLVertexShape::callback ( SoCallbackAction * action)
virtual

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoShape.

◆ doAction()

void SoVRMLVertexShape::doAction ( SoAction * action)
virtual

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

◆ generateAndReadLockNormalCache()

SoNormalCache * SoVRMLVertexShape::generateAndReadLockNormalCache ( SoState *const state)
protected

Convenience method that can be used by subclasses to return or create a normal cache. If the current cache is not valid, it takes care of unrefing the old cache and pushing and popping the state to create element dependencies when creating the new cache.

When returning from this method, the normal cache will be read locked, and the caller should call readUnlockNormalCache() when the normals in the cache is no longer needed.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since
Coin 2.0

◆ generateDefaultNormals() [1/2]

SbBool SoVRMLVertexShape::generateDefaultNormals ( SoState * s,
SoNormalBundle * nb )
virtual

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

Subclasses should override this method to generate default normals using the SoNormalBundle class. TRUE should be returned if normals were generated, FALSE otherwise.

Default method returns FALSE.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Reimplemented in SoVRMLIndexedFaceSet.

◆ generateDefaultNormals() [2/2]

SbBool SoVRMLVertexShape::generateDefaultNormals ( SoState * s,
SoNormalCache * nc )
virtual

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

Subclasses should override this method to generate default normals using the SoNormalCache class. This is more effective than using SoNormalGenerator. Return TRUE if normals were generated, FALSE otherwise.

Default method just returns FALSE.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Reimplemented in SoVRMLIndexedFaceSet.

◆ getBoundingBox()

void SoVRMLVertexShape::getBoundingBox ( SoGetBoundingBoxAction * action)
virtual

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoShape.

◆ getClassTypeId()

SoType SoVRMLVertexShape::getClassTypeId ( void )
static

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

◆ getFieldData()

const SoFieldData * SoVRMLVertexShape::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 SoVRMLGeometry.

Reimplemented in SoVRMLIndexedFaceSet, and SoVRMLIndexedShape.

◆ getFieldDataPtr()

const SoFieldData ** SoVRMLVertexShape::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.

◆ getTypeId()

SoType SoVRMLVertexShape::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 SoVRMLGeometry.

Reimplemented in SoVRMLIndexedFaceSet, and SoVRMLIndexedShape.

◆ getVertexData()

void SoVRMLVertexShape::getVertexData ( SoState * state,
const SoCoordinateElement *& coords,
const SbVec3f *& normals,
const SbBool neednormals )
protected

Convenience method that returns the current coordinate and normal element. This method is not part of the OIV API.

◆ GLRender()

void SoVRMLVertexShape::GLRender ( SoGLRenderAction * action)
virtual

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method.

Reimplemented from SoShape.

Reimplemented in SoVRMLIndexedFaceSet.

◆ initClass()

void SoVRMLVertexShape::initClass ( void )
static

◆ notify()

void SoVRMLVertexShape::notify ( SoNotList * l)
virtual

Notifies all auditors for this instance when changes are made.

Reimplemented from SoVRMLGeometry.

Reimplemented in SoVRMLIndexedShape.

◆ pick()

void SoVRMLVertexShape::pick ( SoPickAction * action)
virtual

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

◆ readLockNormalCache()

void SoVRMLVertexShape::readLockNormalCache ( void )
protected

Read lock the normal cache. This method should be called before fetching the normal cache (using getNormalCache()). When the cached normals are no longer needed, readUnlockNormalCache() must be called.

It is also possible to use generateAndReadLockNormalCache().

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

See also
readUnlockNormalCache()
Since
Coin 2.0

◆ readUnlockNormalCache()

void SoVRMLVertexShape::readUnlockNormalCache ( void )
protected

Read unlock the normal cache. Should be called when the read-locked cached normals are no longer needed.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

See also
readLockNormalCache()
Since
Coin 2.0

◆ shouldGLRender()

SbBool SoVRMLVertexShape::shouldGLRender ( SoGLRenderAction * action)
protectedvirtual

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

Reimplemented from SoVRMLGeometry.

Member Data Documentation

◆ color

SoSFNode SoVRMLVertexShape::color

Can contain an SoVRMLColor node.

◆ colorPerVertex

SoSFBool SoVRMLVertexShape::colorPerVertex

When TRUE, colors are applied per vertex. Default value is TRUE.

◆ coord

SoSFNode SoVRMLVertexShape::coord

Should contain an SoVRMLCoordinate node.

◆ normal

SoSFNode SoVRMLVertexShape::normal

Can contain an SoVRMLNormal node.

◆ normalPerVertex

SoSFBool SoVRMLVertexShape::normalPerVertex

When TRUE, normals are applied per vertex. Default value is TRUE.

◆ texCoord

SoSFNode SoVRMLVertexShape::texCoord

Can contain an SoVRMLTextureCoordinate node.


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