SoClipPlane(3)

📦 version 3.1.3, in fedora 43, fedora 44

🌸 NAME 🌸

SoClipPlane — bestie, it's literally the node type for specifying clipping planes. That's the whole assignment, no cap. 💅

✨ SYNOPSIS ✨

First thing's first, include this header:

#include <Inventor/nodes/SoClipPlane.h>

It inherits from SoNode, and SoClipPlaneManip inherits from it. Family tree, periodt. 🫶

💅 Public Member Functions 💅

These are the functions SoClipPlane itself brings to the function party:

virtual SoType getTypeId (void) const
SoClipPlane (void)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void pick (SoPickAction *action)

🦋 Public Member Functions inherited from SoNode 🦋

The whole SoNode starter pack, inherited and iconic:

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 GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *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)
uint32_t 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

🌈 Public Member Functions inherited from SoFieldContainer 🌈

More inherited goodies 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 🌸

And from SoBase, because the ancestry is deep:

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 public functions, because sometimes you need class-level energy:

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

✨ Static Public Member Functions inherited from SoNode ✨

Inherited static public functions 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 🍓

Inherited static public functions 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 💜

Inherited static public functions 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 👑

Public attributes, the main character data members:

SoSFPlane plane
SoSFBool on

🎀 Protected Member Functions 🎀

Protected member functions, for the inner circle:

virtual const SoFieldData * getFieldData (void) const
virtual ~SoClipPlane ()

🧚 Protected Member Functions inherited from SoNode 🧚

Inherited protected member functions from SoNode:

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

🦋 Protected Member Functions inherited from SoFieldContainer 🦋

Inherited protected member functions from SoFieldContainer:

SoFieldContainer (void)
virtual ~SoFieldContainer ()

🌈 Protected Member Functions inherited from SoBase 🌈

Inherited protected member functions 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 protected member functions, because even the protected ones have class-level moves:

static const SoFieldData ** getFieldDataPtr (void)

✨ Static Protected Member Functions inherited from SoNode ✨

Inherited static protected member functions 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 🍓

Inherited static protected member functions from SoBase:

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

👑 Additional Inherited Members 👑

💜 Public Types inherited from SoNode 💜

The NodeType enum, inherited from SoNode, with all the values:

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 }

🎀 Protected Types inherited from SoBase 🎀

The BaseFlags enum, inherited from SoBase:

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

🧚 Protected Attributes inherited from SoNode 🧚

Protected attribute inherited from SoNode:

uint32_t uniqueId

🦋 Protected Attributes inherited from SoFieldContainer 🦋

Protected attribute inherited from SoFieldContainer:

SbBool isBuiltIn

🌈 Static Protected Attributes inherited from SoNode 🌈

Static protected attributes inherited from SoNode:

static uint32_t nextUniqueId = 1
static int nextActionMethodIndex = 0

💖 Detailed Description 💖

Okay so SoClipPlane is a node type for specifying clipping planes. Literally what it says on the tin, bestie. ✨

A scene graph without any SoClipPlane nodes uses six clipping planes to define the viewing frustum: top, bottom, left, right, near and far. If you want extra clipping planes for "slicing" the visible geometry, you can do that by using nodes of this type. Geometry on the back side of the clipping plane is clipped away. So if you're trying to slice, this is your girl. 🔥

Note that OpenGL implementations have a fixed maximum number of clipping planes available. To find out what this number is, you can use the following code:
#include <Inventor/elements/SoGLClipPlaneElement.h>
// ...[snip]...
int maxplanes = SoGLClipPlaneElement::getMaxGLPlanes();

Below is a simple, basic scene graph usage example of SoClipPlane. It connects an SoClipPlane to an SoCenterballDragger, for end-user control over the orientation and position of the clipping plane:

#Inventor V2.1 ascii

Separator {
   Separator {
      Translation { translation -6 0 0 }
      DEF cbdragger CenterballDragger { }
   }

   TransformSeparator {
      Transform {
         rotation 0 0 1 0 = USE cbdragger . rotation
         translation 0 0 0 = USE cbdragger . center
      }
      ClipPlane { }
   }

   Sphere { }
}

Note that SoClipPlane is a state-changing appearance node, and as such, it will only assert its effects under the current SoSeparator node (as the SoSeparator pops the state stack when traversal returns above it), as can be witnessed by loading this simple example file into a Coin viewer:

#Inventor V2.1 ascii

Separator {
   ClipPlane { }
   Cube { }
}

Separator {
   Translation { translation -3 0 0 }
   Cube { }
}

FILE FORMAT/DEFAULTS:

ClipPlane {
    plane 1 0 0  0
    on TRUE
}

🎀 Constructor & Destructor Documentation 🎀

SoClipPlane::SoClipPlane (void )

Constructor. Just constructor things. ✨

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

Destructor. Protected and virtual, so it's giving exclusive access. 💅

💖 Member Function Documentation 💖

Okay bestie, let's get into the member functions. These are the methods that make SoClipPlane do its thing. Slay. 💅

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

So this function? It's literally the type ID detector. It returns the type identification of an object derived from a class inheriting SoBase. Why do we care? Because it's used for run-time type checking and "downward" casting. No cap.

Usage example, and yes it's giving iconic:

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

Now for all my application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or others — listen up: this method needs to be overridden in all subclasses. Periodt. 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. Iykyk.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. It's all there, bestie.

✨ Implements SoBase.
💅 Reimplemented in SoClipPlaneManip.

const SoFieldData * SoClipPlane::getFieldData (void ) const [protected], [virtual] 🎀

This one hands you a pointer to the class-wide field data storage object for this instance. If no fields are present? It returns NULL. Simple as that. 💁‍♀️

💡 Reimplemented from SoFieldContainer.
💅 Reimplemented in SoClipPlaneManip.

void SoClipPlane::doAction (SoAction * action) [virtual] 🔥

This function performs the typical operation of a node for any action. That's it, that's the vibe. ✨

💡 Reimplemented from SoNode.
💅 Reimplemented in SoClipPlaneManip.

void SoClipPlane::GLRender (SoGLRenderAction * action) [virtual] 🌈

Action method for the SoGLRenderAction. This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. Slay. 👑

💡 Reimplemented from SoNode.
💅 Reimplemented in SoClipPlaneManip.

void SoClipPlane::callback (SoCallbackAction * action) [virtual] 💖

Action method for SoCallbackAction. 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. Iconic. 🦋

💡 Reimplemented from SoNode.
💅 Reimplemented in SoClipPlaneManip.

void SoClipPlane::pick (SoPickAction * action) [virtual] 🎯

Action method for SoPickAction. Does common processing for SoPickAction action instances. Lowkey essential. 💅

💡 Reimplemented from SoNode.
💅 Reimplemented in SoClipPlaneManip.

✨ Member Data Documentation ✨

Now for the data members, because the fields are the whole point, right? 🫶

SoSFPlane SoClipPlane::plane 🛩️

Definition of clipping plane. Geometry on the back side of the clipping plane is clipped away.

The default clipping plane has its normal pointing in the <1,0,0> direction, and intersects origo. (I.e., everything along the negative X axis is clipped.) No cap. 💀

SoSFBool SoClipPlane::on 🔛

Whether clipping plane should be on or off. Defaults to TRUE. Periodt. 💖

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

This iconic page was served to you by Coin, version 3.1.3, for the SoClipPlane(3) manual page. Stay slaying, bestie! 💅✨🌈

📦 where this page comes from