Internal class. More...

#include <Inventor/nodes/SoText2.h>

Inheritance diagram for SoText2:

Public Types
enum	Justification { LEFT = 0x01 , RIGHT = 0x02 , CENTER = 0x03 }
	Justification types. More...

Public Types inherited from SoShape
enum	TriangleShape { TRIANGLE_STRIP , TRIANGLE_FAN , TRIANGLES , POLYGON }
	This type is used by the triangle shape generation methods (beginShape, etc.) More...

typedef void	VertexArrayRenderingCB(SoNode shape, SoGLRenderAction , bool useVbo, uint32_t numVertices)
	callback used for pre/post vertex array rendering on SoVertexShapes (MeVis ONLY) More...

Public Types inherited from SoNode
enum	Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }

Fields
SoMFString	string
	The text string(s) to display. More...

SoSFFloat	spacing
	Defines the distance (in the negative y direction) between the base points of successive strings, measured with respect to the current font height. More...

SoSFEnum	justification
	Indicates placement and alignment of strings. More...

	SoText2 ()
	Creates a 2D text node with default settings. More...

virtual void	GLRender (SoGLRenderAction *action)
	Implements rendering by rendering each primitive generated by subclass. More...

virtual void	rayPick (SoRayPickAction *action)
	Implements picking along a ray by intersecting the ray with each primitive generated by subclass. More...

static void	initClass ()

virtual void	generatePrimitives (SoAction *action)
	This method is a no-op for SoText2, since there are no primitives it can generate. More...

virtual void	computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
	Computes bounding box of text. More...

virtual	~SoText2 ()

Additional Inherited Members
Public Member Functions inherited from SoShape
virtual bool	affectsState () const
	Overrides default method on SoNode. More...

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
	Implements bounding box method using virtual computeBBox() method. More...

virtual void	callback (SoCallbackAction *action)
	Implements primitive generation for all shapes. More...

Public Member Functions inherited from SoNode
void	setOverride (bool state)
	Turns override flag on or off. More...

bool	isOverride () const
	Returns the state of the override flag. More...

SoNode *	copy (bool copyConnections=FALSE) const
	Creates and returns an exact copy of the node. More...

virtual void	doAction (SoAction *action)
	This method performs the "typical" operation of a node for any action. More...

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	GLRenderBelowPath (SoGLRenderAction *action)
	These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes. More...

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	grabEventsSetup ()
	These virtual functions are called when a node gains or loses status as "grabber" of events (see HandleEventAction::setGrabber()). More...

virtual void	grabEventsCleanup ()

virtual void	startNotify ()
	Initiates notification from an instance. More...

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance. More...

SbNodeIdType	getNodeId () const
	Returns the unique id for a node. More...

virtual SoChildList *	getChildren () const
	Returns pointer to children, or NULL if none. More...

virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used for either stage of writing.) More...

virtual SoNode *	addToCopyDict () const
	Recursively adds this node and all nodes under it to the copy dictionary. More...

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance. More...

virtual SoFieldContainer *	copyThroughConnection () const
	Copies an instance that is encountered through a field connection. More...

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values. More...

bool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values. More...

bool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to `fc's` fields. More...

void	copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
	Copies the contents of `fc's` fields into this object's fields. More...

bool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format. More...

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...

virtual int	getFields (SoFieldList &list) const
	Appends pointers to all of this object's fields to resultList, and returns the number of fields appended. More...

virtual SoField *	getField (const SbName &fieldName) const
	Returns a pointer to the field with the given name. More...

bool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the `fieldName` argument. More...

bool	enableNotify (bool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). More...

bool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed. More...

bool	set (const char fieldDataString, SoInput dictIn)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format. More...

void	get (SbString &fieldDataString, SoOutput *dictOut)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing. More...

bool	getIsBuiltIn () const
	Returns whether or not instance is considered 'built-in' to the library. More...

virtual const SoFieldData *	getFieldData () const
	Returns an SoFieldData structure for the node. More...

void	addManagedSensor (SoSensor *sensor)
	Adds a sensor which is managed by the field container. More...

Public Member Functions inherited from SoBase
void	ref () const
	Adds and removes a reference to an instance. More...

void	unref () const

void	unrefNoDelete () const

void	touch ()
	Marks an instance as modified, simulating a change to it. More...

virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance. More...

bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in `type` or is derived from that type. More...

virtual SbName	getName () const
	Returns the name of an instance. More...

virtual void	setName (const SbName &name)
	Sets the name of an instance. More...

void	addAuditor (void *auditor, SoNotRec::Type type)
	Adds/removes an auditor to/from list. More...

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

const SoAuditorList &	getAuditors ()
	Returns auditor list– used by SoField and SoEngineOutput to trace forward connections. More...

int	getRefCount () const
	Returns current reference count. More...

bool	shouldWrite ()
	Returns TRUE if the instance should be written, based on the write-reference info already accumulated. More...

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

static void	getScreenSize (SoState *state, const SbBox3f &boundingBox, SbVec2s &rectSize)
	This can be used by subclasses when the complexity type is SCREEN_SPACE to determine how many window pixels are covered by the shape. More...

static void	setPreVertexArrayRenderingCallback (VertexArrayRenderingCB *cb)
	register global pre callback for vertex array rendering (MeVis ONLY) More...

static void	setPostVertexArrayRenderingCallback (VertexArrayRenderingCB *cb)
	register global post callback for vertex array rendering (MeVis ONLY) More...

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns type identifier for the SoNode class. More...

static SoNode *	getByName (const SbName &name)
	Returns the last node given the specified name. More...

static int	getByName (const SbName &name, SoNodeList &list)
	Returns the number of nodes with the given name, and adds to `list` pointers to those nodes. More...

static void	initClass ()
	Initializes base node class. More...

static void	initClasses ()
	Initialize ALL Inventor node classes. More...

static SbNodeIdType	getNextNodeId ()
	Returns the next available unique id. More...

static int	getActionMethodIndex (SoType t)
	Returns the index of this node in the action/method table, given its type. More...

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class. More...

static void	initClass ()
	Setup type information. More...

static void	initCopyDict ()
	During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used. More...

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)
	Adds an instance to the dictionary. More...

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
	If a copy of the given instance is in the dictionary, this returns it. More...

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, bool copyConnections)
	If a copy of the given instance is not in the dictionary, this returns NULL. More...

static void	copyDone ()
	Cleans up the dictionary when done. More...

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class. More...

static void	initClass ()
	Setup type information. More...

static void	incrementCurrentWriteCounter ()
	Increments the current write counter at the start of a write operation. More...

static void	decrementCurrentWriteCounter ()
	Decrements the current write counter after a write operation, in some rare cases. More...

static void	addName (SoBase , const char )
	Internal methods used to maintain the global name dictionary. More...

static void	removeName (SoBase , const char )

static SoBase *	getNamedBase (const SbName &, SoType)
	Helper routines used to get stuff out of nameDict. More...

static int	getNamedBases (const SbName &, SoBaseList &, SoType)

static bool	read (SoInput in, SoBase &base, SoType expectedType)
	Reads one instance of some subclass of SoBase. More...

static void	setInstancePrefix (const SbString &c)
	This defaults to "+" and is used when naming nodes that are DEF's and USE'd. More...

Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging) More...

Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
	This set of enums is used when reading and writing the base. More...

Protected Member Functions inherited from SoShape
	SoShape ()
	Constructor. More...

virtual bool	shouldGLRender (SoGLRenderAction *action)
	Returns TRUE if the shape should be rendered. More...

bool	shouldRayPick (SoRayPickAction *action)
	Returns TRUE if the shape may be picked. More...

void	beginSolidShape (SoGLRenderAction *action)
	These can be used by solid shapes to indicate so during rendering. More...

void	endSolidShape (SoGLRenderAction *action)

void	computeObjectSpaceRay (SoRayPickAction *action)
	Computes a picking ray in the object space of the shape instance. More...

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

virtual SoDetail *	createTriangleDetail (SoRayPickAction action, const SoPrimitiveVertex v1, const SoPrimitiveVertex v2, const SoPrimitiveVertex v3, SoPickedPoint *pp)
	These methods are called during picking to create details representing extra info about a pick intersection. More...

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 action, const SoPrimitiveVertex v1, const SoPrimitiveVertex v2, const SoPrimitiveVertex v3)
	These methods invoke whatever callbacks are registered with the primitive generation procedures. More...

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

void	invokePointCallbacks (SoAction action, const SoPrimitiveVertex v)

void	beginShape (SoAction action, TriangleShape shapeType, SoFaceDetail faceDetail=NULL)
	These methods can be used by subclasses to generate triangles more easily when those triangles are part of a larger structure, such as a triangle strip, triangle fan, or triangulated polygon, according to the TriangleShape enumerated type. More...

void	shapeVertex (const SoPrimitiveVertex *v)

void	endShape ()

virtual	~SoShape ()

void	GLRenderBoundingBox (SoGLRenderAction *action)
	Applies GLRender action to the bounding box surrounding the shape. More...

Protected Member Functions inherited from SoNode
	SoNode ()
	Constructor, destructor. More...

virtual	~SoNode ()

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()

	~SoFieldContainer ()

virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error. More...

Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class. More...

virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly. More...

virtual void	destroy ()
	Actually deletes an instance. More...

bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references. More...

bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput. More...

void	writeFooter (SoOutput *out) const

virtual const char *	getFileFormatName () const
	Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned) More...

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr ()
	This is used by the field-inheritence mechanism, hidden in the SoSubNode macros. More...

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter. More...

Protected Attributes inherited from SoNode
SbNodeIdType	uniqueId
	Unique id for this node. More...

Protected Attributes inherited from SoFieldContainer
bool	isBuiltIn
	Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information. More...

Static Protected Attributes inherited from SoShape
static VertexArrayRenderingCB *	_preVertexArrayRenderingCB

static VertexArrayRenderingCB *	_postVertexArrayRenderingCB

Static Protected Attributes inherited from SoNode
static SbNodeIdType	nextUniqueId
	Next available unique id. More...

static int	nextActionMethodIndex
	Next index into the action method table. More...

Detailed Description

Screen-aligned 2D text shape node.

This node defines one or more strings of 2D text. The text is always aligned horizontally with the screen and does not change size with distance in a perspective projection. The text origin is at (0,0,0) after applying the current transformation. Rotations and scales have no effect on the orientation or size of 2D text, just the location.

SoText2 uses the current font to determine the typeface and size. The text is always drawn with the diffuse color of the current material; it is not lit, regardless of the lighting model. Furthermore, 2D text can not be textured, and it ignores the current drawing style and complexity.

Because 2D text is screen-aligned, it has some unusual characteristics. For example, the 3D bounding box surrounding a 2D text string depends on the current camera and the current viewport size, since changing the field of view or the mapping onto the window changes the relative size of the text with respect to the rest of the scene. This has implications for caching as well, since a render cache in an SoSeparator that contains an SoText2 node depends on the current camera.

File Format/Default

: Text2 {

string ""

spacing 1

justification LEFT

}

SoText2::LEFT
@ LEFT
Definition: SoText2.h:131

SoText2::spacing
SoSFFloat spacing
Defines the distance (in the negative y direction) between the base points of successive strings,...
Definition: SoText2.h:147

SoText2::justification
SoSFEnum justification
Indicates placement and alignment of strings.
Definition: SoText2.h:155

Action Behavior

: SoGLRenderAction
Draws text based on the current font, at a location based on the current transformation.

: SoRayPickAction
Performs a pick on the text. Text will be picked if the picking ray intersects the bounding box of the strings. The string index and character position are available from the SoTextDetail.

: SoGetBoundingBoxAction
Computes the bounding box that encloses the text.

See Also

: SoFont, SoText3, SoTextDetail

Definition at line 122 of file SoText2.h.

Member Enumeration Documentation

◆ Justification

enum SoText2::Justification

Enumerator
LEFT
RIGHT
CENTER

Definition at line 129 of file SoText2.h.

Constructor & Destructor Documentation

◆ SoText2()

SoText2::SoText2 ( )

◆ ~SoText2()

virtual SoText2::~SoText2 ( )

protectedvirtual

Member Function Documentation

◆ computeBBox()

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

protectedvirtual

Implements SoShape.

◆ generatePrimitives()

virtual void SoText2::generatePrimitives ( SoAction * action )

protectedvirtual

Implements SoShape.

◆ GLRender()

virtual void SoText2::GLRender ( SoGLRenderAction * action )

virtual

May be overridden in subclass.

Reimplemented from SoShape.

◆ initClass()

static void SoText2::initClass ( )

static

◆ rayPick()

virtual void SoText2::rayPick ( SoRayPickAction * action )

virtual

May be overridden in subclass.

Reimplemented from SoShape.

Member Data Documentation

◆ justification

SoSFEnum SoText2::justification

With LEFT justification, the left edge of the first line is at the (transformed) origin, and all left edges are aligned. RIGHT justification is similar. CENTER justification places the center of the first string at the (transformed) origin, with the centers of all remaining strings aligned under it.

Definition at line 155 of file SoText2.h.

◆ spacing

SoSFFloat SoText2::spacing

A value of 1 indicates single spacing, a value of 2 indicates double spacing, and so on.

Definition at line 147 of file SoText2.h.

◆ string

SoMFString SoText2::string

Each string will appear on its own line. The string(s) can be ascii or UTF-8.

Definition at line 141 of file SoText2.h.

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

/home/jenkins/workspaces/mevislab/3.7.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/nodes/SoText2.h

Public Types

Fields

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Justification

Constructor & Destructor Documentation

◆ SoText2()

◆ ~SoText2()

Member Function Documentation

◆ computeBBox()

◆ generatePrimitives()

◆ GLRender()

◆ initClass()

◆ rayPick()

Member Data Documentation

◆ justification

◆ spacing

◆ string