other versions
- wheezy-backports 3.1.4~abc9f50-3~bpo70+1
- jessie 3.1.4~abc9f50-7
SoText2(3) | Coin | SoText2(3) |
NAME¶
SoText2 - The SoText2 class is a node type for visualizing 2D text aligned with the camera plane. SoText2 text is not scaled according to the distance from the camera, and is not influenced by rotation or scaling as 3D primitives are. If these are properties that you want the text to have, you should instead use an SoText3 or SoAsciiText node.SYNOPSIS¶
#include <Inventor/nodes/SoText2.h> Inherits SoShape.Public Types¶
enum Justification { LEFT = 1, RIGHT, CENTER }
Public Member Functions¶
virtual SoType getTypeId (void) const
Static Public Member Functions¶
static SoType getClassTypeId (void)
Public Attributes¶
SoMFString string
Protected Member Functions¶
virtual const SoFieldData * getFieldData (void) const
Static Protected Member Functions¶
static const SoFieldData ** getFieldDataPtr (void)
Additional Inherited Members¶
Detailed Description¶
The SoText2 class is a node type for visualizing 2D text aligned with the camera plane. SoText2 text is not scaled according to the distance from the camera, and is not influenced by rotation or scaling as 3D primitives are. If these are properties that you want the text to have, you should instead use an SoText3 or SoAsciiText node.Text2 { string '' spacing 1 justification LEFT }See Also:
SoFont, SoFontStyle,
SoText3, SoAsciiText
Member Enumeration Documentation¶
enum SoText2::Justification¶
Enum contains the various options for how the horizontal text layout text should be done. Valid values are LEFT, RIGHT and CENTER.Constructor & Destructor Documentation¶
SoText2::SoText2 (void)¶
Constructor.SoText2::~SoText2 () [protected], [virtual]¶
Destructor.Member Function Documentation¶
SoType SoText2::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.
const SoFieldData ** SoText2::getFieldDataPtr (void) [static], [protected]¶
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.const SoFieldData * SoText2::getFieldData (void) const [protected], [virtual]¶
Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. Reimplemented from SoShape.void SoText2::GLRender (SoGLRenderAction *action) [virtual]¶
Action method for the SoGLRenderAction. This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. Reimplemented from SoShape.void SoText2::rayPick (SoRayPickAction *action) [virtual]¶
Calculates picked point based on primitives generated by subclasses. Reimplemented from SoShape.void SoText2::getPrimitiveCount (SoGetPrimitiveCountAction *action) [virtual]¶
Action method for the SoGetPrimitiveCountAction. Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables. Reimplemented from SoShape.void SoText2::generatePrimitives (SoAction *action) [protected], [virtual]¶
The method implements action behavior for shape nodes for SoCallbackAction. It is invoked from SoShape::callback(). (Subclasses should not override SoNode::callback().) The subclass implementations uses the convenience methods SoShape::beginShape(), SoShape::shapeVertex(), and SoShape::endShape(), with SoDetail instances, to pass the primitives making up the shape back to the caller. Implements SoShape.void SoText2::computeBBox (SoAction *action, SbBox3f &box, SbVec3f ¢er) [protected], [virtual]¶
Implemented by SoShape subclasses to let the SoShape superclass know the exact size and weighted center point of the shape's bounding box. The bounding box and center point should be calculated and returned in the local coordinate system. The method implements action behavior for shape nodes for SoGetBoundingBoxAction. It is invoked from SoShape::getBoundingBox(). (Subclasses should not override SoNode::getBoundingBox().) The box parameter sent in is guaranteed to be an empty box, while center is undefined upon function entry. Implements SoShape.Member Data Documentation¶
SoMFString SoText2::string¶
The set of strings to render. Each string in the multiple value field will be rendered on it's own line. The default value of the field is a single empty string.SoSFFloat SoText2::spacing¶
Spacing between each consecutive vertical line. Default value is 1.0, which means that the space between the uppermost line of each rendered string will equal the vertical size of the highest character in the bitmap alphabet.SoSFEnum SoText2::justification¶
Decides how the horizontal layout of the text strings is done.Author¶
Generated automatically by Doxygen for Coin from the source code.Sat Oct 12 2013 | Version 4.0.0a |