SoArray(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoArray(3) 💖

okay bestie, welcome to the manual page for SoArray(3) from the Library Functions Manual. she's a group node, she's iconic, and we're about to read every single line together. no skipping. periodt. 💅

🌸 NAME 🌸

SoArray — The SoArray class is a group node for setting up regular arrays of subgraphs. ✨

💅 SYNOPSIS 💅

#include <Inventor/nodes/SoArray.h>

Inherits SoGroup.

🎀 Public Types 🎀

these are the types she defines, bestie:

  • enum Origin { FIRST, CENTER, LAST }

Public Types inherited from SoNode

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 }

🦋 Public Member Functions 🦋

okay these are the methods SoArray itself is bringing to the function party:

  • virtual SoType getTypeId (void) const
  • SoArray (void)
  • virtual SbBool affectsState (void) const
  • virtual void doAction (SoAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)

Public Member Functions inherited from SoGroup

and these are the ones she inherited from SoGroup, because family:

  • SoGroup (void)
  • SoGroup (int nchildren)
  • virtual void addChild (SoNode *node)
  • virtual void insertChild (SoNode *child, int newchildindex)
  • virtual SoNode * getChild (int index) const
  • virtual int findChild (const SoNode *node) const
  • virtual int getNumChildren (void) const
  • virtual void removeChild (int childindex)
  • virtual void removeChild (SoNode *child)
  • virtual void removeAllChildren (void)
  • virtual void replaceChild (int index, SoNode *newchild)
  • virtual void replaceChild (SoNode *oldchild, SoNode *newchild)
  • virtual void write (SoWriteAction *action)
  • virtual SoChildList * getChildren (void) const

Public Member Functions inherited from SoNode

  • 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 void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • uint32_t getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • virtual SoFieldContainer * copyThroughConnection (void) const

Public Member Functions inherited from SoFieldContainer

  • 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 void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

Public Member Functions inherited from SoBase

  • 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
  • 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 Public Member Functions 💖

  • static SoType getClassTypeId (void)
  • static void initClass (void)

Static Public Member Functions inherited from SoGroup

  • static SoType getClassTypeId (void)
  • static void initClass (void)

Static Public Member Functions inherited from SoNode

  • 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 uint32_t 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 Public Member Functions inherited from SoFieldContainer

  • 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 Public Member Functions inherited from SoBase

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • 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)

✨ Public Attributes ✨

these are the fields, and yes you need all of them:

  • SoSFEnum origin
  • SoSFShort numElements1
  • SoSFShort numElements2
  • SoSFShort numElements3
  • SoSFVec3f separation1
  • SoSFVec3f separation2
  • SoSFVec3f separation3

🌈 Protected Member Functions 🌈

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoArray ()

Protected Member Functions inherited from SoGroup

  • virtual ~SoGroup ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual SbBool readChildren (SoInput *in)
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)

Protected Member Functions inherited from SoNode

  • SoNode (void)
  • virtual ~SoNode ()

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

Protected Member Functions inherited from SoBase

  • SoBase (void)
  • virtual ~SoBase ()
  • virtual void destroy (void)
  • SbBool hasMultipleWriteRefs (void) const
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter (SoOutput *out) const
  • virtual const char * getFileFormatName (void) const

🧚 Static Protected Member Functions 🧚

  • static const SoFieldData ** getFieldDataPtr (void)

Static Protected Member Functions inherited from SoGroup

  • static const SoFieldData ** getFieldDataPtr (void)

Static Protected Member Functions inherited from SoNode

  • 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 Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

👑 Additional Inherited Members 👑

Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Protected Attributes inherited from SoGroup

  • SoChildList * children

Protected Attributes inherited from SoNode

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1
  • static int nextActionMethodIndex = 0

✨ Detailed Description ✨

The SoArray class is a group node for setting up regular arrays of subgraphs.

SoArray presents a convenient way of duplicating a node (typically a shape node) or a complete subgraph in 1 to 3 dimensions.

The child node or subgraph can only be translated by regular offsets for all dimensions.

For more flexible functionality for duplication of geometry, see the SoMultipleCopy group node, which can do general transformations (including rotation and scaling) for its child.

🎀 FILE FORMAT/DEFAULTS 🎀

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

🌸 See also 🌸

SoMultipleCopy

💜 Member Enumeration Documentation 💜

enum SoArray::Origin

The possible settings for the SoArray::origin field.

💀 Constructor & Destructor Documentation 💀

SoArray::SoArray (void )

Constructor.

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

Destructor.

✨ Member Function Documentation ✨

🦋 SoType SoArray::getTypeId (void ) const [virtual]

okay so bestie, this one hands you back the type identification of an object that's derived from a class inheriting SoBase. it's literally the backbone of run-time type checking, and it's how you pull off a "downward" casting. no cap. 💅

usage example, and yes i'm giving it to you exactly as-is because you do not mess with working code:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

now — if you're an application programmer who wants to extend the library with new nodes, engines, nodekits, draggers or others, this method needs to be overridden in all subclasses. periodt. you typically do that as part of setting up the full type system for your 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. 🌸

wanna know more about writing Coin extensions? go read the class documentation of the toplevel superclasses for the various class groups. iykyk.

Reimplemented from SoGroup.

💜 const SoFieldData * SoArray::getFieldData (void ) const [protected], [virtual]

returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present at all? it returns NULL. that's it, that's the whole vibe. 🫶

Reimplemented from SoGroup.

⭐ SbBool SoArray::affectsState (void ) const [virtual]

returns TRUE if the node could have any effect on the state during traversal.

if it returns FALSE, then no data in the traversal-state will change from the pre-traversal state to the post-traversal state. like, take SoSeparator — it returns FALSE, because it pushes and pops the state before and after traversal of its children. and all SoShape nodes also return FALSE, since just pushing out geometry data to the rendering engine won't affect the actual rendering state. 💀

the default method returns TRUE, on a "better safe than sorry" philosophy. iconic honestly.

Reimplemented from SoNode.

🎀 void SoArray::doAction (SoAction * action) [virtual]

this function performs the typical operation of a node for any action. that's the whole job description, bestie. ✨

Reimplemented from SoGroup.

🌈 void SoArray::callback (SoCallbackAction * action) [virtual]

action method for SoCallbackAction.

it simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. so thoughtful of it. 🥺

Reimplemented from SoGroup.

🔥 void SoArray::GLRender (SoGLRenderAction * action) [virtual]

action method for the SoGLRenderAction.

this one gets called during rendering traversals. nodes influencing the rendering state in any way, or who wants to throw geometry primitives at OpenGL, overrides this method. main character energy fr fr.

Reimplemented from SoGroup.

💖 void SoArray::pick (SoPickAction * action) [virtual]

action method for SoPickAction.

does common processing for SoPickAction action instances. nothing more, nothing less, and we respect that. 👑

Reimplemented from SoGroup.

🌸 void SoArray::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

action method for the SoGetBoundingBoxAction.

calculates bounding box and center coordinates for node, and modifies the values of the action to encompass the bounding box for this node, and to shift the center point for the scene more towards the one for this node. very "i contain multitudes" of it. 💅

nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoGroup.

🧚 void SoArray::handleEvent (SoHandleEventAction * action) [virtual]

action method for SoHandleEventAction.

inspects the event data from action, and processes it if it is something which this node should react to. (read: if it's this node's business, it handles it. otherwise, not my problem.) 🙈

nodes influencing relevant state variables for how event handling is done also overrides this method.

Reimplemented from SoGroup.

🦋 void SoArray::getMatrix (SoGetMatrixAction * action) [virtual]

action method for SoGetMatrixAction.

updates action by accumulating with the transformation matrix of this node (if any). "if any" doing so much heavy lifting there bestie.

Reimplemented from SoGroup.

💜 void SoArray::search (SoSearchAction * action) [virtual]

action method for SoSearchAction.

compares the search criteria from the action to see if this node is a match. searching is done by matching up all criteria set up in the SoSearchAction — if any of the requested criteria is a miss, the search is not deemed successful for the node. strict queen behavior. ✨

See also

  • SoSearchAction
Reimplemented from SoGroup.

⭐ void SoArray::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

action method for the SoGetPrimitiveCountAction.

calculates the number of triangle, line segment and point primitives for the node, and adds these to the counters of the action. math girlies rise up. 📐

nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoGroup.

🎀 void SoArray::audioRender (SoAudioRenderAction * action) [virtual]

action method for SoAudioRenderAction.

does common processing for SoAudioRenderAction action instances. it's giving soundtrack era. 🎧

Reimplemented from SoGroup.

💖 Member Data Documentation 💖

SoSFEnum SoArray::origin

where the origin of the array should be set — ie how the array elements will be distributed from the local origo.

default value is SoArray::FIRST. remember it, bestie, it's a vibe check for your whole array. 🫶

SoSFShort SoArray::numElements1

number of duplicates for each X axis row. default 1.

SoSFShort SoArray::numElements2

number of duplicates for each Y axis row. default 1.

SoSFShort SoArray::numElements3

number of duplicates for each Z axis row. default 1.

SoSFVec3f SoArray::separation1

distance in current units between the center point of each element along the X axis. default [1.0, 0.0, 0.0].

SoSFVec3f SoArray::separation2

distance in current units between the center point of each element along the Y axis. default [0.0, 1.0, 0.0].

SoSFVec3f SoArray::separation3

distance in current units between the center point of each element along the Z axis. default [0.0, 0.0, 1.0].

🌈 Author 🌈

generated automatically by Doxygen for Coin from the source code. it didn't write itself, but honestly? it kind of did. 😭

okay that's a wrap on SoArray(3) bestie — this whole thing came out of the Coin docs, Version 3.1.3, and you can come back to it whenever the array math starts acting up. go slay your scene graph, ily, bye!! 🎀💖✨

📦 where this page comes from