soinfo(3)
NAME
SoInfo
SYNOPSIS
#include <Inventor/nodes/SoInfo.h> Inherits SoNode.
Detailed Description
The SoInfo class is a node for holding text information.
This is simply a placeholder for textual information about a scene.
Typically used for specifying author and copyright information in
Inventor format files, but can also be used for other purposes, of
course.
SoInfo nodes does not influence traversal in any way for any of the
builtin actions.
- FILE FORMAT/DEFAULTS:
- Info {
string '<Undefined info>'
- }
- Public Member Functions
- virtual SoType getTypeId (void) const
SoInfo (void) - Static Public Member Functions
- static SoType getClassTypeId (void) static void initClass (void)
- Public Attributes
- SoSFString string
- Protected Member Functions
- virtual const SoFieldData * getFieldData (void) const virtual ~SoInfo ()
- Static Protected Member Functions
- static const SoFieldData ** getFieldDataPtr (void)
Constructor & Destructor Documentation
- SoInfo::SoInfo (void)
- Constructor.
- SoInfo::~SoInfo () [protected, virtual]
- Destructor.
- References SoNode::VRML1.
Member Function Documentation
- SoType SoInfo::getClassTypeId (void) [static]
- This static method returns the SoType object associated with objects of this class.
- Reimplemented from SoNode.
- SoType SoInfo::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}
else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {SoGroup * group = (SoGroup *)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. - Implements SoBase.
- const SoFieldData ** SoInfo::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 SoNode.
- const SoFieldData * SoInfo::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 SoFieldContainer.
- void SoInfo::initClass (void) [static]
- Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
- Reimplemented from SoNode.
- Referenced by SoNode::initClasses().
Member Data Documentation
- SoSFString SoInfo::string
- Text information.
Author
- Generated automatically by Doxygen for Coin from the source code.