Open Inventor Reference
SoV1CustomNode Class Reference

#include <Inventor/misc/upgraders/SoV1CustomNode.h>

Inheritance diagram for SoV1CustomNode:
SoUpgrader SoGroup SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

 SoV1CustomNode ()
 Default constructor.
virtual SbBool upgrade (SoInput *in, const SbName &refName, SoBase *&result)
 There are 9 steps to reading in and upgrading a custom node; happily, subclasses only have to worry about three virtual methods: createNewNode() -- MUST be implemented interpretCustomData() -- optional setUpNewNode() -- also optional See comments below for more info...

Static Public Member Functions

static void initClass ()
 which is responsible for looking at the className field and creating an appropriate replacement node.

Public Attributes

Fields
SoMFName className
 Names in custom subclass hierarchy.
SoMFString fields
 Field data strings, 1 per subclass.
SoMFString customData
 Custom data strings, 1 per subclass.

Protected Member Functions

virtual SoNodecreateNewNode ()
 createNewNode should look at the className field and create an appropriate replacement node.
virtual void interpretCustomData (SoV1CustomNode *inst, int index) const
 This method is called to let subclass instances do whatever they have to do based on the info in the customData field value with the given index after the given instance has been read.
virtual void setUpNewNode (SoNode *newNode)
 This method is passed the new node (created by the createNewNode method, above).
virtual ~SoV1CustomNode ()

Detailed Description

Definition at line 69 of file SoV1CustomNode.h.


Constructor & Destructor Documentation

SoV1CustomNode::SoV1CustomNode ( )
virtual SoV1CustomNode::~SoV1CustomNode ( ) [protected, virtual]

Member Function Documentation

virtual SoNode* SoV1CustomNode::createNewNode ( ) [protected, virtual]

The default method prints an error message. This is called after fields have been read, but before children are read.

Implements SoUpgrader.

static void SoV1CustomNode::initClass ( ) [static]

Reimplemented from SoUpgrader.

virtual void SoV1CustomNode::interpretCustomData ( SoV1CustomNode inst,
int  index 
) const [protected, virtual]

The default does nothing. This is called after createNewNode, before children have been read.

virtual void SoV1CustomNode::setUpNewNode ( SoNode newNode) [protected, virtual]

It must copy the fields from the V1 upgrader instance into the new node, and must move the children from the upgrader to the new node. The default method does nothing.

virtual SbBool SoV1CustomNode::upgrade ( SoInput in,
const SbName refName,
SoBase *&  result 
) [virtual]

Reimplemented from SoUpgrader.


Member Data Documentation


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