|
| SoProto (const SbBool externproto=FALSE) |
|
virtual SoType | getTypeId (void) const |
| Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.
|
|
SoProtoInstance * | createProtoInstance (void) |
|
void | addISReference (SoNode *container, const SbName &fieldname, const SbName &interfacename) |
|
SbName | findISReference (const SoFieldContainer *container, const SbName &fieldname) |
|
void | addReference (const SbName &name, SoBase *base) |
|
void | removeReference (const SbName &name) |
|
SoBase * | findReference (const SbName &name) const |
|
void | addRoute (const SbName &fromnode, const SbName &fromfield, const SbName &tonode, const SbName &tofield) |
|
SbName | getProtoName (void) const |
|
virtual SbBool | readInstance (SoInput *input, unsigned short flags) |
|
virtual void | write (SoWriteAction *action) |
|
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 SbBool | affectsState (void) const |
|
virtual void | doAction (SoAction *action) |
|
virtual void | GLRender (SoGLRenderAction *action) |
|
virtual void | GLRenderBelowPath (SoGLRenderAction *action) |
|
virtual void | GLRenderInPath (SoGLRenderAction *action) |
|
virtual void | GLRenderOffPath (SoGLRenderAction *action) |
|
virtual void | callback (SoCallbackAction *action) |
|
virtual void | getBoundingBox (SoGetBoundingBoxAction *action) |
|
virtual void | getMatrix (SoGetMatrixAction *action) |
|
virtual void | handleEvent (SoHandleEventAction *action) |
|
virtual void | pick (SoPickAction *action) |
|
virtual void | rayPick (SoRayPickAction *action) |
|
virtual void | search (SoSearchAction *action) |
|
virtual void | audioRender (SoAudioRenderAction *action) |
|
virtual void | getPrimitiveCount (SoGetPrimitiveCountAction *action) |
|
virtual void | grabEventsSetup (void) |
|
virtual void | grabEventsCleanup (void) |
|
virtual void | startNotify (void) |
|
virtual void | notify (SoNotList *l) |
|
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 |
|
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 const SoFieldData * | getFieldData (void) const |
|
virtual void | getFieldsMemorySize (size_t &managed, size_t &unmanaged) const |
|
void | setUserData (void *userdata) const |
|
void * | getUserData (void) const |
|
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 |
| Returns TRUE if the type of this object is either of the same type or inherited from type.
|
|
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 void | setFetchExternProtoCallback (SoFetchExternProtoCB *cb, void *closure) |
|
static SoType | getClassTypeId (void) |
|
static SoProto * | findProto (const SbName &name) |
|
static void | initClass (void) |
|
static uint32_t | getCompatibilityTypes (const SoType &nodetype) |
|
static SoType | getClassTypeId (void) |
|
static SoNode * | getByName (const SbName &name) |
|
static int | getByName (const SbName &name, SoNodeList &l) |
|
static void | initClass (void) |
|
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 void | initClass (void) |
|
static SoType | getClassTypeId (void) |
|
static void | cleanupClass (void) |
|
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 void | initClass (void) |
| Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
|
|
static SoType | getClassTypeId (void) |
| This static method returns the SoType object associated with objects of this class.
|
|
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) |
|
|
enum | NodeType {
INVENTOR = 0x0000
, VRML1 = 0x0001
, VRML2 = 0x0002
, INVENTOR_1 = 0x0004
,
INVENTOR_2_0 = 0x0008
, INVENTOR_2_1 = 0x0010
, INVENTOR_2_5 = 0x0020
, INVENTOR_2_6 = 0x0040
,
COIN_1_0 = 0x0080
, COIN_2_0 = 0x0100
, EXTENSION = 0x0200
, COIN_2_2 = 0x0400
,
COIN_2_3 = 0x0800
, COIN_2_4 = 0x1000
, INVENTOR_5_0 = 0x2000
, COIN_2_5 = 0x4000
,
COIN_3_0 = 0x8000
, INVENTOR_6_0 = 0x10000
, COIN_4_0 = 0x20000
} |
|
enum | BaseFlags { IS_ENGINE = 0x01
, IS_GROUP = 0x02
} |
|
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 uint32_t | getCurrentWriteCounter (void) |
|
static void | staticDataLock (void) |
|
static void | staticDataUnlock (void) |
|
SbUniqueId | uniqueId |
|
SbBool | isBuiltIn |
|
static SbUniqueId | nextUniqueId = 1 |
|
static int | nextActionMethodIndex = 0 |
|
The SoProto class handles PROTO definitions.
SoProto and SoProtoInstance are mostly internal classes. They're designed to read and handle VRML97 PROTOs. However, it's possible to define your protos in C++. You must define your proto in a char array, and read that char array using SoInput::setBuffer() and SoDB::readAllVRML(). Example:
"#VRML V2.0 utf8\n"
"PROTO ColorCube [\n"
" field SFColor color 1 1 1\n"
" field SFVec3f size 1 1 1\n"
"]\n"
"{\n"
" Shape {\n"
" appearance Appearance {\n"
" material Material {\n"
" diffuseColor IS color\n"
" }\n"
" }\n"
" geometry Box { size IS size }\n"
" }\n"
"}\n"
"ColorCube { color 1 0 0 size 2 1 1 }\n";
The SbList class is a template container class for lists.
Definition SbList.h:70
static SoVRMLGroup * readAllVRML(SoInput *input)
Definition SoDB.cpp:693
The SoVRMLGroup class is used for grouping VRML nodes.
Definition SoVRMLGroup.h:45
Now you can create new instances of the ColorCube proto using SoProto::findProto() and SoProto::createProtoInstance(). If you want to insert proto instances into your scene graph, you should insert the node returned from SoProtoInstance::getRootNode().
See http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.8 for more information about PROTOs in VRML97.
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:
{
if (node->
getTypeId() == SoFile::getClassTypeId()) {
}
}
virtual SoType getTypeId(void) const =0
Returns the type identification of an object derived from a class inheriting SoBase....
The SoFile class is node container for another model file.
Definition SoFile.h:43
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
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.
This method is mainly intended for internal use during file import operations.
It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.
TRUE
or FALSE
is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE
.
flags is used internally during binary import when reading user extension nodes, group nodes or engines.
Reimplemented from SoNode.