The SoText2Set class is a node type for visualizing a set of 2D texts aligned with the camera plane. More...

#include <SmallChange/nodes/SoText2Set.h>

Public Types
enum	Justification { LEFT = 1, RIGHT, CENTER }

Public Types inherited from SoShape
enum	TriangleShape

Public Types inherited from SoNode
enum	NodeType

Public Member Functions
virtual void	GLRender (SoGLRenderAction *action)

virtual void	rayPick (SoRayPickAction *action)

virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)

	SoText2Set (void)

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

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	write (SoWriteAction *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
SoMFEnum	justification

SoMFString	string

SoMFVec3f	position

SoMFFloat	rotation

SoSFBool	renderOutline

SoSFInt32	maxStringsToRender

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	~SoText2Set ()

virtual void	notify (SoNotList *list)

virtual void	generatePrimitives (SoAction *action)

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

Protected Member Functions inherited from SoShape
virtual const SoFieldData *	getFieldData (void) const

	SoShape (void)

virtual	~SoShape ()

float	getComplexityValue (SoAction *action)

virtual SbBool	shouldGLRender (SoGLRenderAction *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 SoText2Set class is a node type for visualizing a set of 2D texts aligned with the camera plane.

See documentation of Inventor/shapenodes/SoText2

SoText2Set is identical to the built-in SoText2 node except for:

Each string is positioned independently in 3D space
Each string is aligned independently
Each string is rotated independently (in the camera plane)

The main purpose of this node is optimization; by collecting all text that should be rendered with the same font settings in one SoText2Set node, overhead is reduced.

A secondary purpose is to allow rotated rendering of 2D text.

Note that if you want to render multi-line text, SoText2 is probably a better choice since that node takes care of vertical spacing automatically. With SoText2Set each string is positioned directly in 3D space.

FIXME: rayPick() does not function properly with rotated strings unless they are CENTERed.

See also: SoText2

Member Enumeration Documentation

◆ Justification

enum SoText2Set::Justification

Enum contains the various options for how the horizontal text layout text should be done. Valid values are LEFT, RIGHT and CENTER.

Enumerator
LEFT
RIGHT
CENTER

Constructor & Destructor Documentation

◆ SoText2Set()

SoText2Set::SoText2Set ( void )

Constructor.

◆ ~SoText2Set()

SoText2Set::~SoText2Set ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ computeBBox()

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

protectedvirtual

Implements SoShape.

◆ generatePrimitives()

void SoText2Set::generatePrimitives ( SoAction * action )

protectedvirtual

Implements SoShape.

◆ getPrimitiveCount()

void SoText2Set::getPrimitiveCount ( SoGetPrimitiveCountAction * action )

virtual

Reimplemented from SoShape.

◆ GLRender()

void SoText2Set::GLRender ( SoGLRenderAction * action )

virtual

Reimplemented from SoShape.

◆ initClass()

void SoText2Set::initClass ( void )

static

◆ notify()

void SoText2Set::notify ( SoNotList * list )

protectedvirtual

Overloaded to disable geometry cache.

Reimplemented from SoShape.

◆ rayPick()

void SoText2Set::rayPick ( SoRayPickAction * action )

virtual

Reimplemented from SoShape.

Member Data Documentation

◆ justification

SoMFEnum SoText2Set::justification

Decides how the horizontal layout of each text string is done.

◆ maxStringsToRender

SoSFInt32 SoText2Set::maxStringsToRender

Specifies how many strings to render based on their closeness to the camera.

◆ position

SoMFVec3f SoText2Set::position

Position of each string in local coordinate space.

◆ renderOutline

SoSFBool SoText2Set::renderOutline

When TRUE, text will be rendered as white text with a black border. Default value is FALSE.

◆ rotation

SoMFFloat SoText2Set::rotation

Angle in radians between the text and the horisontal, in the camera plane. Positive direction is counter clockwise.

◆ string

SoMFString SoText2Set::string

The set of strings to render. string[i] is rendered at position[i], justified according to justification[i] and rotated according to rotation[i].

The default value of the field is a single empty string.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Justification

Constructor & Destructor Documentation

◆ SoText2Set()

◆ ~SoText2Set()

Member Function Documentation

◆ computeBBox()

◆ generatePrimitives()

◆ getPrimitiveCount()

◆ GLRender()

◆ initClass()

◆ notify()

◆ rayPick()

Member Data Documentation

◆ justification

◆ maxStringsToRender

◆ position

◆ renderOutline

◆ rotation

◆ string