Defining the Constructor

The constructor defines the fields for the node and sets up their default values. If the fields contain enumerated values, their names and values are defined in the constructor as well. Use the SO_NODE_CONSTRUCTOR() macro to perform the basic work. In any case, custom OIV nodes should always define a default constructor.

The SO_NODE_IS_FIRST_INSTANCE() macro returns a Boolean value that can be tested in constructors. If your class requires considerable overhead when it is initialized, you may want to perform this work only once when the first instance of the class is created. For example, the SoCube class sets up the coordinates and normals of the cube faces during construction of its first instance. (You could put this code in the initClass() method, but putting it in the constructor guarantees that someone is actually using your node class first.)

Setting Up the Node's Fields

The SO_NODE_ADD_FIELD() macro defines the fields in the node and sets up their default values. The first parameter is the name of the field. The second parameter is the default field value, in parentheses. Using

SoDrawStyle as an example:

SO_NODE_ADD_FIELD( style, ( SoDrawStyleElement::getDefault() ) );
SO_NODE_ADD_FIELD( lineWidth, ( SoLineWidthElement::getDefault() ) );
SO_NODE_ADD_FIELD( linePattern, ( SoLinePatternElement::getDefault() ) );

To add a field with a vector value, the syntax is as follows:

SO_NODE_ADD_FIELD( translation, ( 0.0, 0.0, 0.0 ) );

Defining Enumerated Values for a Field

In the preceding example, the style field contains an enumerated value: FILLED, LINES, POINTS, or INVISIBLE. Use the SO_NODE_DEFINE_- ENUM_VALUE() macro to define the enumerated values. The first parameter is the type of the enumerated value. The second parameter is its value, as shown here:

SO_NODE_DEFINE_ENUM_VALUE( Style, FILLED );
SO_NODE_DEFINE_ENUM_VALUE( Style, LINES );
SO_NODE_DEFINE_ENUM_VALUE( Style, POINTS );
SO_NODE_DEFINE_ENUM_VALUE( Style, INVISIBLE );

Then, to specify that these enumerated values can be used in the style field of the SoDrawStyle node, use the SO_NODE_SET_SF_ENUM_TYPE() macro:

SO_NODE_SET_SF_ENUM_TYPE( style, Style );