SoClipPlane(3)
🎀 SoClipPlane(3) 🎀
okay so bestie, gather round, because today we're talking about SoClipPlane(3) — the manual page, the moment, the icon. it's giving library functions manual energy and honestly? we're obsessed. 💅
✨ NAME ✨
SoClipPlane — the SoClipPlane class is a node type for specifying clipping planes. like, that's literally its whole job and it does it beautifully. 🦋
🌸 SYNOPSIS 🌸
#include <Inventor/nodes/SoClipPlane.h>Inherits SoNode.
Inherited by SoClipPlaneManip.
💖 Public Member Functions
the inner circle, the main squad:
virtual SoType getTypeId (void) const— the type-id getter 🆔SoClipPlane (void)— constructor, hiiii 👋virtual void doAction (SoAction *action)— does the action, no capvirtual void GLRender (SoGLRenderAction *action)— GL render time ✨virtual void callback (SoCallbackAction *action)— callback behaviourvirtual void pick (SoPickAction *action)— the pick pass
🫶 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=0) 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
void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool
copyconnections=0)
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 *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool getIsBuiltIn (void) 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 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 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 *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename,
const SbName &fromfieldname, const SbName &tonodename, const SbName
&tofieldname)
static SbBool readRoute (SoInput *in)👑 Public Attributes
the two fields that run this whole operation:
SoSFPlane planeSoSFBool on
🔥 Protected Member Functions
virtual const SoFieldData * getFieldData (void) const
virtual ~SoClipPlane ()💫 Protected Member Functions inherited from SoNode
SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)🫧 Protected Member Functions inherited from SoFieldContainer
SoFieldContainer (void)
~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 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
💖 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
}💜 Protected Types inherited from SoBase
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }🌟 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 = 0
static int nextActionMethodIndex = 0🌈 Detailed Description 🌈
The SoClipPlane class is a node type for specifying clipping planes. that's the whole thing, bestie, that's the assignment. 💅
A scene graph without any SoClipPlane nodes uses six clipping planes to define the viewing frustum: top, bottom, left, right, near and far. iconic behaviour honestly.
But if you want extra clipping planes for "slicing" the visible geometry? you can totally do that with nodes of this type. geometry on the back side of the clipping plane gets clipped away. bye bye geometry 👋✨
note that OpenGL implementations have a fixed maximum number of clipping planes available. so like, there's a limit, and you can't just go feral with it. 🫠
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. the origin story. 🎬
References on, plane, and SoClipPlane().
Referenced by getFieldData(), SoClipPlaneManip::replaceManip(), SoClipPlaneManip::replaceNode(), SoClipPlane(), and SoClipPlaneManip::transferFieldValues().
🦋 SoClipPlane::~SoClipPlane () [protected], [virtual]
Destructor. the end of an era 😭💜
💖 Member Function Documentation 💖
✨ SoType SoClipPlane::getTypeId (void ) const [virtual] ✨
Bestie, this one returns the type ID of any object that inherits from SoBase. It's literally the run-time type checking and "downward" casting plug. Iconic behavior.
Usage example:
void foo(SoNode * node)
{
if (node->getTypeId() == SoFile::getClassTypeId()) {
SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type
}
else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
SoGroup * group = (SoGroup *)node; // safe downward cast, knows the type
}
}If you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. 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.
For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.
Implements SoBase.
Reimplemented in SoClipPlaneManip.
✨ const SoFieldData * SoClipPlane::getFieldData (void ) const [protected], [virtual] ✨
Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. No cap.
Reimplemented from SoFieldContainer.
Reimplemented in SoClipPlaneManip.
References SoClipPlane().
✨ void SoClipPlane::doAction (SoAction * action) [virtual] ✨
This function performs the typical operation of a node for any action. It's giving main character energy for actions.
Reimplemented from SoNode.
Reimplemented in SoClipPlaneManip.
References SoAction::getState(), on, and plane.
Referenced by callback(), GLRender(), and pick().
✨ 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. OpenGL girlies, this one's for you.
Reimplemented from SoNode.
Reimplemented in SoClipPlaneManip.
References doAction(), SoAction::getState(), on, plane, and SbPlane::transform().
Referenced by SoClipPlaneManip::GLRender().
✨ 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. Lowkey useful for snooping on the scene graph.
Reimplemented from SoNode.
Reimplemented in SoClipPlaneManip.
References doAction().
Referenced by SoClipPlaneManip::callback().
✨ void SoClipPlane::pick (SoPickAction * action) [virtual] ✨
Action method for SoPickAction.
Does common processing for SoPickAction action instances. Pick me, choose me, love me.
Reimplemented from SoNode.
Reimplemented in SoClipPlaneManip.
References doAction().
Referenced by SoClipPlaneManip::pick().
🦋 Member Data Documentation 🦋
🌸 SoSFPlane SoClipPlane::plane 🌸
Definition of clipping plane. Geometry on the back side of the clipping plane is clipped away. Gone. Deleted. Not invited.
The default clipping plane has it's normal pointing in the <1,0,0> direction, and intersects origo. (I.e., everything along the negative X axis is clipped.)
Referenced by doAction(), SoClipPlaneManip::fieldSensorCB(), GLRender(), SoClipPlaneManip::setValue(), SoClipPlane(), SoClipPlaneManip::transferFieldValues(), and SoClipPlaneManip::valueChangedCB().
🌸 SoSFBool SoClipPlane::on 🌸
Whether clipping plane should be on or off. Defaults to TRUE. On periodt.
Referenced by doAction(), GLRender(), SoClipPlane(), and SoClipPlaneManip::transferFieldValues().
🌟 Author 🌟
Generated automatically by Doxygen for Coin from the source code. Doxygen ate and left no crumbs.
Okay so that's the whole page, bestie. The footer's giving Coin, Version 2.5.0, and SoClipPlane(3) — periodt. 💅✨
📦 where this page comes from
- fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
- fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms