Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoArray Class Reference

Group node that creates a regular IxJxK array of copies of its children. More...

#include <Inventor/nodes/SoArray.h>

+ Inheritance diagram for SoArray:

Public Types

enum  Origin {
  FIRST ,
  CENTER ,
  LAST
}
 Array origin. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoArray ()
 Creates an array node with default settings.
 
virtual SbBool affectsState () const
 Overrides default method on SoNode to return FALSE since arrays are effectively separators.
 
- Public Member Functions inherited from SoGroup
 SoGroup ()
 Creates an empty group node.
 
 SoGroup (int nChildren)
 Constructor that takes approximate number of children.
 
virtual void addChild (SoNode *child)
 Adds a child as last one in group.
 
virtual void insertChild (SoNode *child, int newChildIndex)
 Adds a child so that it becomes the one with the given index.
 
virtual SoNodegetChild (int index) const
 Returns pointer the child node with the given index.
 
virtual int findChild (const SoNode *child) const
 Finds index of given child within group.
 
virtual int getNumChildren () const
 Returns number of children.
 
virtual void removeChild (int index)
 Removes child with given index from group.
 
virtual void removeChild (SoNode *child)
 Removes first instance of given child from group.
 
virtual void removeAllChildren ()
 Removes all children from group.
 
virtual void replaceChild (int index, SoNode *newChild)
 Replaces child with given index with new child.
 
virtual void replaceChild (SoNode *oldChild, SoNode *newChild)
 Replaces first instance of given child with new child.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoGroup
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoSFShort numElements1
 Number of elements in the 1st dimension.
 
SoSFShort numElements2
 Number of elements in the 2nd dimension.
 
SoSFShort numElements3
 Number of elements in the 3rd dimension.
 
SoSFVec3f separation1
 Separation vector in the 1st dimension.
 
SoSFVec3f separation2
 Separation vector in the 2nd dimension.
 
SoSFVec3f separation3
 Separation vector in the 3rd dimension.
 
SoSFEnum origin
 Defines the base point from which copies are distributed.
 
- Public Attributes inherited from SoGroup
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Detailed Description

Group node that creates a regular IxJxK array of copies of its children.

This group node traverses its children, in order, several times, creating a regular 3D array of copies of them. The number of copies in each of the three directions is specified by fields, as are the vectors used to separate the copies in each of the three dimensions.

For example, an SoArray node can be used to create a 2x3x4 array of copies of its children, where the separation vectors between adjacent copies in the three array dimensions are (1,2,3), (-4,-5,-6), and (7,8,9), respectively. The base point of the array can be set to one of several values, as described in the origin field.

Copies are traversed so that the first dimension cycles most quickly, followed by the second, and then the third. This order is important because SoArray sets the current switch value to N before traversing the children for the Nth time (for use with inherited switch values - see SoSwitch).

FILE FORMAT/DEFAULT

    Array {
    numElements1 1
    numElements2 1
    numElements3 1
    separation1 1 0 0
    separation2 0 1 0
    separation3 0 0 1
    origin FIRST
    }

ACTION BEHAVIOR

SEE ALSO

SoMultipleCopy, SoSwitch

Definition at line 127 of file SoArray.h.

Member Enumeration Documentation

◆ Origin

Array origin.

Enumerator
FIRST 

First copy is rendered at the current local origin; all other copies are distributed relative to it.

CENTER 

Copies are distributed relative to the center of the array.

LAST 

Last copy is rendered at the current local origin; all other copies are distributed relative to it.

Definition at line 165 of file SoArray.h.

Constructor & Destructor Documentation

◆ SoArray()

SoArray::SoArray ( )

Creates an array node with default settings.

Member Function Documentation

◆ affectsState()

virtual SbBool SoArray::affectsState ( ) const
virtual

Overrides default method on SoNode to return FALSE since arrays are effectively separators.

Reimplemented from SoNode.

◆ getClassTypeId()

static SoType SoArray::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoArray::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoGroup.

Member Data Documentation

◆ numElements1

SoSFShort SoArray::numElements1

Number of elements in the 1st dimension.

Definition at line 137 of file SoArray.h.

◆ numElements2

SoSFShort SoArray::numElements2

Number of elements in the 2nd dimension.

Definition at line 142 of file SoArray.h.

◆ numElements3

SoSFShort SoArray::numElements3

Number of elements in the 3rd dimension.

Definition at line 147 of file SoArray.h.

◆ origin

SoSFEnum SoArray::origin

Defines the base point from which copies are distributed.

Use enum Origin. Default is FIRST.

Definition at line 186 of file SoArray.h.

◆ separation1

SoSFVec3f SoArray::separation1

Separation vector in the 1st dimension.

Definition at line 152 of file SoArray.h.

◆ separation2

SoSFVec3f SoArray::separation2

Separation vector in the 2nd dimension.

Definition at line 157 of file SoArray.h.

◆ separation3

SoSFVec3f SoArray::separation3

Separation vector in the 3rd dimension.

Definition at line 162 of file SoArray.h.


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