The SoVertexShape class is the superclass for all vertex based shapes. More...

#include <Inventor/nodes/SoVertexShape.h>

Inheritance diagram for SoVertexShape:

Public Member Functions
virtual SoType	getTypeId (void) const
	Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. More...

virtual void	notify (SoNotList *nl)

virtual SbBool	generateDefaultNormals (SoState state, SoNormalBundle bundle)

virtual SbBool	generateDefaultNormals (SoState state, SoNormalCache cache)

virtual void	write (SoWriteAction *action)

Public Member Functions inherited from SoShape
virtual SbBool	affectsState (void) const

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	GLRender (SoGLRenderAction *action)

virtual void	rayPick (SoRayPickAction *action)

virtual void	callback (SoCallbackAction *action)

virtual void	computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)=0

virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)

const SoBoundingBoxCache *	getBoundingBoxCache (void) const

Public Member Functions inherited from SoNode
void	setOverride (const SbBool state)

SbBool	isOverride (void) const

void	setNodeType (const NodeType type)

NodeType	getNodeType (void) const

virtual SoNode *	copy (SbBool copyconnections=FALSE) const

virtual void	doAction (SoAction *action)

virtual void	GLRenderBelowPath (SoGLRenderAction *action)

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	pick (SoPickAction *action)

virtual void	search (SoSearchAction *action)

virtual void	audioRender (SoAudioRenderAction *action)

virtual void	grabEventsSetup (void)

virtual void	grabEventsCleanup (void)

virtual void	startNotify (void)

SbUniqueId	getNodeId (void) const

virtual SoChildList *	getChildren (void) const

virtual void	writeInstance (SoOutput *out)

virtual SoNode *	addToCopyDict (void) const

virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)

virtual SoFieldContainer *	copyThroughConnection (void) const

Public Member Functions inherited from SoFieldContainer
void	setToDefaults (void)

SbBool	hasDefaultValues (void) const

SbBool	fieldsAreEqual (const SoFieldContainer *container) const

void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)

SbBool	set (const char *const fielddata)

void	get (SbString &fielddata)

virtual int	getFields (SoFieldList &l) const

virtual int	getAllFields (SoFieldList &l) const

virtual SoField *	getField (const SbName &name) const

virtual SoField *	getEventIn (const SbName &name) const

virtual SoField *	getEventOut (const SbName &name) const

SbBool	getFieldName (const SoField *const field, SbName &name) const

SbBool	enableNotify (const SbBool flag)

SbBool	isNotifyEnabled (void) const

SbBool	set (const char fielddata, SoInput input)

void	get (SbString &fielddata, SoOutput *out)

virtual SbBool	validateNewFieldValue (SoField field, void newval)

virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

SbBool	getIsBuiltIn (void) const

virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) const

void	setUserData (void *userdata) const

void *	getUserData (void) const

Public Member Functions inherited from SoBase
void	ref (void) const

void	unref (void) const

void	unrefNoDelete (void) const

int32_t	getRefCount (void) const

void	touch (void)

SbBool	isOfType (SoType type) const
	Returns `TRUE` if the type of this object is either of the same type or inherited from type. More...

virtual SbName	getName (void) const

virtual void	setName (const SbName &newname)

void	addAuditor (void *const auditor, const SoNotRec::Type type)

void	removeAuditor (void *const auditor, const SoNotRec::Type type)

const SoAuditorList &	getAuditors (void) const

SbBool	shouldWrite (void)

void	assertAlive (void) const

Static Public Member Functions
static SoType	getClassTypeId (void)

static void	initClass (void)

Static Public Member Functions inherited from SoShape
static SoType	getClassTypeId (void)

static void	initClass (void)

static void	getScreenSize (SoState *const state, const SbBox3f &boundingbox, SbVec2s &rectsize)

static float	getDecimatedComplexity (SoState *state, float complexity)

Static Public Member Functions inherited from SoNode
static uint32_t	getCompatibilityTypes (const SoType &nodetype)

static SoType	getClassTypeId (void)

static SoNode *	getByName (const SbName &name)

static int	getByName (const SbName &name, SoNodeList &l)

static void	initClass (void)

static void	initClasses (void)

static SbUniqueId	getNextNodeId (void)

static int	getActionMethodIndex (const SoType type)

static void	getBoundingBoxS (SoAction action, SoNode node)

static void	GLRenderS (SoAction action, SoNode node)

static void	callbackS (SoAction action, SoNode node)

static void	getMatrixS (SoAction action, SoNode node)

static void	handleEventS (SoAction action, SoNode node)

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 void	audioRenderS (SoAction action, SoNode node)

static void	getPrimitiveCountS (SoAction action, SoNode node)

Static Public Member Functions inherited from SoFieldContainer
static void	initClass (void)

static SoType	getClassTypeId (void)

static void	cleanupClass (void)

static void	initCopyDict (void)

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, const SbBool copyconnections)

static void	copyDone (void)

Static Public Member Functions inherited from SoBase
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 SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static void	addName (SoBase const base, const char const name)

static void	removeName (SoBase const base, const char const name)

static void	incrementCurrentWriteCounter (void)

static void	decrementCurrentWriteCounter (void)

static SoBase *	getNamedBase (const SbName &name, SoType type)

static int	getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)

static SbBool	read (SoInput input, SoBase &base, SoType expectedtype)

static void	setInstancePrefix (const SbString &c)

static void	setTraceRefs (SbBool trace)

static SbBool	getTraceRefs (void)

static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)

static SbBool	readRoute (SoInput *input)

Public Attributes
SoSFNode	vertexProperty

Protected Member Functions
virtual const SoFieldData *	getFieldData (void) const

	SoVertexShape (void)

virtual	~SoVertexShape ()

virtual SbBool	shouldGLRender (SoGLRenderAction *action)

void	setNormalCache (SoState const state, const int num, const SbVec3f normals)

SoNormalCache *	getNormalCache (void) const

SoNormalCache *	generateAndReadLockNormalCache (SoState *const state)

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

void	readLockNormalCache (void)

void	readUnlockNormalCache (void)

Protected Member Functions inherited from SoShape
	SoShape (void)

virtual	~SoShape ()

float	getComplexityValue (SoAction *action)

virtual void	generatePrimitives (SoAction *action)=0

void	beginSolidShape (SoGLRenderAction *action)

void	endSolidShape (SoGLRenderAction *action)

void	GLRenderBoundingBox (SoGLRenderAction *action)

SbBool	shouldPrimitiveCount (SoGetPrimitiveCountAction *action)

SbBool	shouldRayPick (SoRayPickAction *const action)

void	computeObjectSpaceRay (SoRayPickAction *const action)

void	computeObjectSpaceRay (SoRayPickAction *const action, const SbMatrix &matrix)

virtual SoDetail *	createTriangleDetail (SoRayPickAction action, const SoPrimitiveVertex v1, const SoPrimitiveVertex v2, const SoPrimitiveVertex v3, SoPickedPoint *pp)

virtual SoDetail *	createLineSegmentDetail (SoRayPickAction action, const SoPrimitiveVertex v1, const SoPrimitiveVertex v2, SoPickedPoint pp)

virtual SoDetail *	createPointDetail (SoRayPickAction action, const SoPrimitiveVertex v, SoPickedPoint *pp)

void	invokeTriangleCallbacks (SoAction const action, const SoPrimitiveVertex const v1, const SoPrimitiveVertex const v2, const SoPrimitiveVertex const v3)

void	invokeLineSegmentCallbacks (SoAction const action, const SoPrimitiveVertex const v1, const SoPrimitiveVertex *const v2)

void	invokePointCallbacks (SoAction const action, const SoPrimitiveVertex const v)

void	beginShape (SoAction const action, const TriangleShape shapetype, SoDetail const detail=NULL)

void	shapeVertex (const SoPrimitiveVertex *const v)

void	endShape (void)

void	generateVertex (SoPrimitiveVertex const pv, const SbVec3f &point, const SbBool useTexFunc, const SoMultiTextureCoordinateElement const tce, const float s, const float t, 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 float r, const SbVec3f &normal)

SbBool	startVertexArray (SoGLRenderAction action, const SoCoordinateElement coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex)

void	finishVertexArray (SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, 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 void	destroy (void)

SbBool	hasMultipleWriteRefs (void) const

SbBool	writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const

void	writeFooter (SoOutput *out) const

virtual const char *	getFileFormatName (void) const

virtual SoNotRec	createNotRec (void)

Static Protected Member Functions
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 void	setNextActionMethodIndex (int index)

static int	getNextActionMethodIndex (void)

static void	incNextActionMethodIndex (void)

static void	setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)

static void	staticDataLock (void)

static void	staticDataUnlock (void)

Additional Inherited Members
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 }

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 SbUniqueId	nextUniqueId = 1

static int	nextActionMethodIndex = 0

Detailed Description

The SoVertexShape class is the superclass for all vertex based shapes.

Basically, every polygon-, line- or point-based shape will inherit this class. It contains methods for organizing the normal cache, and also holds the SoVertexShape::vertexProperty field which can be used to set vertex data inside the node.

Constructor & Destructor Documentation

◆ SoVertexShape()

SoVertexShape::SoVertexShape ( void )

protected

Constructor.

◆ ~SoVertexShape()

SoVertexShape::~SoVertexShape ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ getTypeId()

SoType SoVertexShape::getTypeId ( void ) const

virtual

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

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoShape.

Reimplemented in SoIndexedFaceSet, SoIndexedLineSet, SoIndexedTriangleStripSet, SoIndexedPointSet, SoFaceSet, SoIndexedMarkerSet, SoIndexedShape, SoNonIndexedShape, SoLineSet, SoMarkerSet, SoPointSet, SoQuadMesh, and SoTriangleStripSet.

◆ getFieldData()

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

Reimplemented in SoIndexedFaceSet, SoIndexedLineSet, SoIndexedTriangleStripSet, SoIndexedPointSet, SoFaceSet, SoIndexedMarkerSet, SoIndexedShape, SoNonIndexedShape, SoLineSet, SoMarkerSet, SoPointSet, SoQuadMesh, and SoTriangleStripSet.

◆ notify()

void SoVertexShape::notify ( SoNotList * l )

virtual

Notifies all auditors for this instance when changes are made.

Reimplemented from SoShape.

Reimplemented in SoIndexedLineSet, and SoIndexedPointSet.

◆ generateDefaultNormals() [1/2]

SbBool SoVertexShape::generateDefaultNormals	(	SoState *	state,
		SoNormalBundle *	bundle
	)

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 SoIndexedPointSet, SoPointSet, SoIndexedFaceSet, SoIndexedTriangleStripSet, SoQuadMesh, SoFaceSet, and SoTriangleStripSet.

◆ generateDefaultNormals() [2/2]

SbBool SoVertexShape::generateDefaultNormals	(	SoState *	state,
		SoNormalCache *	cache
	)

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 SoQuadMesh, SoFaceSet, SoIndexedPointSet, SoIndexedTriangleStripSet, SoPointSet, SoTriangleStripSet, and SoIndexedFaceSet.

◆ write()

void SoVertexShape::write ( SoWriteAction * action )

virtual

Action method for SoWriteAction.

Writes out a node object, and any connected nodes, engines etc, if necessary.

Reimplemented from SoNode.

◆ shouldGLRender()

SbBool SoVertexShape::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 SoShape.

◆ setNormalCache()

void SoVertexShape::setNormalCache	(	SoState *const	state,
		const int	num,
		const SbVec3f *	normals
	)

protected

Sets normal cache to contain the normals specified by normals and num, and forces cache dependencies on coordinates, shape hints and crease angle.

◆ getNormalCache()

SoNormalCache * SoVertexShape::getNormalCache ( void ) const

protected

Returns the current normal cache, or NULL if there is none.

◆ generateAndReadLockNormalCache()

SoNormalCache * SoVertexShape::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

◆ getVertexData()

void SoVertexShape::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.

◆ readLockNormalCache()

void SoVertexShape::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 SoVertexShape::readUnlockNormalCache ( void )

protected

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

See also: readLockNormalCache()

Since: Coin 2.0

Member Data Documentation

◆ vertexProperty

SoSFNode SoVertexShape::vertexProperty

If you set the vertexProperty field, it should be with an SoVertexProperty node. Otherwise it will simply be ignored. Nodetypes inheriting SoVertexShape will then get their coordinate data from the vertexProperty node instead of from the global traversal state.

The vertexProperty field of SoVertexShape-derived nodes breaks somewhat with the basic design of Open Inventor, as its contents are not passed to the global state. This is done to provide a simple path to highly optimized rendering of vertexbased shapes.

See also: SoVertexProperty

Since: Coin 1.0; SGI Inventor v2.1

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

SoVertexShape.h
SoVertexShape.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoVertexShape()

◆ ~SoVertexShape()

Member Function Documentation

◆ getTypeId()

◆ getFieldData()

◆ notify()

◆ generateDefaultNormals() [1/2]

◆ generateDefaultNormals() [2/2]

◆ write()

◆ shouldGLRender()

◆ setNormalCache()

◆ getNormalCache()

◆ generateAndReadLockNormalCache()

◆ getVertexData()

◆ readLockNormalCache()

◆ readUnlockNormalCache()

Member Data Documentation

◆ vertexProperty