The InterleavedArraysShape class is used to render static geometry very fast. More...

#include <SmallChange/nodes/InterleavedArraysShape.h>

Public Types
enum	Type { POINTS, LINES, TRIANGLES, QUADS }

Public Types inherited from SoShape
enum	TriangleShape

Public Types inherited from SoNode
enum	NodeType

Public Member Functions
	InterleavedArraysShape (void)

virtual void	GLRender (SoGLRenderAction *action)

virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)

virtual void	rayPick (SoRayPickAction *action)

Public Member Functions inherited from SoVertexShape
virtual SoType	getTypeId (void) const

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	callback (SoCallbackAction *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

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 void	initClass (void)

Static Public Member Functions inherited from SoShape
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 SoNode *	getByName (const SbName &name)

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

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	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)

static SoType	getClassTypeId (void)

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
SoSFEnum	type

SoMFInt32	vertexIndex

Public Attributes inherited from SoVertexShape
SoSFNode	vertexProperty

Public Attributes inherited from SoNode
	INVENTOR

	VRML1

	VRML2

	INVENTOR_1

	INVENTOR_2_0

	INVENTOR_2_1

	INVENTOR_2_5

	INVENTOR_2_6

	COIN_1_0

	COIN_2_0

	EXTENSION

Protected Member Functions
virtual void	notify (SoNotList *nl)

virtual	~InterleavedArraysShape ()

virtual void	generatePrimitives (SoAction *action)

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

Protected Member Functions inherited from SoVertexShape
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)

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

Additional Inherited Members
Protected Types inherited from SoBase
enum	BaseFlags

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)

Protected Attributes inherited from SoNode
SbUniqueId	uniqueId

Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Static Protected Attributes inherited from SoNode
static SbUniqueId	nextUniqueId

static int	nextActionMethodIndex

Detailed Description

The InterleavedArraysShape class is used to render static geometry very fast.

It creates a VBO (vertex buffer object) vertex cache internally, and all vertex data will be interleaved for maximum rendering performance. If you change one vertex attribute, for instance the normals, the entire cache needs to be rebuilt, and this is why this shape is best suited for relatively static geometry.

To achieve this caching and reduce overhead, it will only render the contents of its SoVertexShape::vertexProperty node, it will not pick up any vertex properties from the state.

This shape only supports OVERALL and PER_VERTEX[_INDEXED] material/normal bindings. If some binding is set to something other than OVERALL, it will be interpreted as PER_VERTEX[_INDEXED], if the SoVertexProperty node contains sufficient data to render that attribute per vertex.

Member Enumeration Documentation

◆ Type

enum InterleavedArraysShape::Type

The type of primitives supported by this shape.

Enumerator
POINTS	For rendering points.
LINES	For rendering lines.
TRIANGLES	For rendering triangles.
QUADS	For rendering quads.

Constructor & Destructor Documentation

◆ InterleavedArraysShape()

InterleavedArraysShape::InterleavedArraysShape ( void )

Constructor.

◆ ~InterleavedArraysShape()

InterleavedArraysShape::~InterleavedArraysShape ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ computeBBox()

void InterleavedArraysShape::computeBBox	(	SoAction *	action,
		SbBox3f &	box,
		SbVec3f &	center
	)

protectedvirtual

Implements SoShape.

◆ generatePrimitives()

void InterleavedArraysShape::generatePrimitives ( SoAction * action )

protectedvirtual

Implements SoShape.

◆ getPrimitiveCount()

void InterleavedArraysShape::getPrimitiveCount ( SoGetPrimitiveCountAction * action )

virtual

Reimplemented from SoShape.

◆ GLRender()

void InterleavedArraysShape::GLRender ( SoGLRenderAction * action )

virtual

Reimplemented from SoShape.

◆ initClass()

void InterleavedArraysShape::initClass ( void )

static

Required Coin method.

◆ notify()

void InterleavedArraysShape::notify ( SoNotList * nl )

protectedvirtual

Reimplemented from SoVertexShape.

◆ rayPick()

void InterleavedArraysShape::rayPick ( SoRayPickAction * action )

virtual

Reimplemented from SoShape.

Member Data Documentation

◆ type

SoSFEnum InterleavedArraysShape::type

The type of geometry to render.

◆ vertexIndex

SoMFInt32 InterleavedArraysShape::vertexIndex

Optional field for specifying vertex indices. If this field is empty, the shape will render all vertices in its SoVertexProperty node (using glDrawArrays()).

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

C:/Data/Volker/Bitbucket/smallchange/lib/SmallChange/nodes/InterleavedArraysShape.h
C:/Data/Volker/Bitbucket/smallchange/lib/SmallChange/nodes/InterleavedArraysShape.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ InterleavedArraysShape()

◆ ~InterleavedArraysShape()

Member Function Documentation

◆ computeBBox()

◆ generatePrimitives()

◆ getPrimitiveCount()

◆ GLRender()

◆ initClass()

◆ notify()

◆ rayPick()

Member Data Documentation

◆ type

◆ vertexIndex