SoClipPlaneManip(3)
π SoClipPlaneManip β the tea β
okay bestie, gather round, because we're talking about SoClipPlaneManip(3) from the Library Functions Manual and honestly? it's giving manipulator royalty. π
β¨ NAME β¨
SoClipPlaneManip β the class that's literally built to manipulate clip planes. that's it, that's the job. no cap. π
πΈ SYNOPSIS πΈ
#include <Inventor/manips/SoClipPlaneManip.h>
Inherits SoClipPlane. yes queen, she's part of the family tree. π³
π«Ά Public Member Functions
virtual SoType getTypeId (void) constSoClipPlaneManip (void)SoDragger * getDragger (void)void setValue (const SbBox3f &box, const SbVec3f &planenormal, float draggerscalefactor)SbBool replaceNode (SoPath *p)SbBool replaceManip (SoPath *p, SoClipPlane *newone) constvirtual void doAction (SoAction *action)virtual void callback (SoCallbackAction *action)virtual void GLRender (SoGLRenderAction *action)virtual void getBoundingBox (SoGetBoundingBoxAction *action)virtual void getMatrix (SoGetMatrixAction *action)virtual void handleEvent (SoHandleEventAction *action)virtual void pick (SoPickAction *action)virtual void search (SoSearchAction *action)virtual SoChildList * getChildren (void) const
π Public Member Functions inherited from SoClipPlane
SoClipPlane (void)
π¦ Public Member Functions inherited from SoNode
void setOverride (const SbBool state)SbBool isOverride (void) constvoid setNodeType (const NodeType type)NodeType getNodeType (void) constvirtual SoNode * copy (SbBool copyconnections=0) constvirtual SbBool affectsState (void) constvirtual void GLRenderBelowPath (SoGLRenderAction *action)virtual void GLRenderInPath (SoGLRenderAction *action)virtual void GLRenderOffPath (SoGLRenderAction *action)virtual void rayPick (SoRayPickAction *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) constvirtual void writeInstance (SoOutput *out)virtual SoNode * addToCopyDict (void) constvirtual SoFieldContainer * copyThroughConnection (void) const
π Public Member Functions inherited from SoFieldContainer
void setToDefaults (void)SbBool hasDefaultValues (void) constSbBool fieldsAreEqual (const SoFieldContainer *container) constvoid copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)SbBool set (const char *const fielddata)void get (SbString &fielddata)virtual int getFields (SoFieldList &l) constvirtual int getAllFields (SoFieldList &l) constvirtual SoField * getField (const SbName &name) constvirtual SoField * getEventIn (const SbName &name) constvirtual SoField * getEventOut (const SbName &name) constSbBool getFieldName (const SoField *const field, SbName &name) constSbBool enableNotify (const SbBool flag)SbBool isNotifyEnabled (void) constSbBool 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) constvoid setUserData (void *userdata) constvoid * getUserData (void) const
β Public Member Functions inherited from SoBase
void ref (void) constvoid unref (void) constvoid unrefNoDelete (void) constint32_t getRefCount (void) constvoid touch (void)SbBool isOfType (SoType type) constvirtual SbName getName (void) constvirtual 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) constSbBool shouldWrite (void)void assertAlive (void) const
π Static Public Member Functions
static SoType getClassTypeId (void)static void initClass (void)
π Static Public Member Functions inherited from SoClipPlane
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
SoSFVec3f draggerPosition
π Public Attributes inherited from SoClipPlane
SoSFPlane planeSoSFBool on
π§ Protected Member Functions
virtual const SoFieldData * getFieldData (void) const~SoClipPlaneManip ()void setDragger (SoDragger *newdragger)virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
π¦ Protected Member Functions inherited from SoClipPlane
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) constSbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) constvoid writeFooter (SoOutput *out) constvirtual const char * getFileFormatName (void) const
β Static Protected Member Functions
static const SoFieldData ** getFieldDataPtr (void)static void valueChangedCB (void *f, SoDragger *d)static void fieldSensorCB (void *f, SoSensor *d)static void transferFieldValues (const SoClipPlane *from, SoClipPlane *to)
π Static Protected Member Functions inherited from SoClipPlane
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)
π¦ Protected Attributes
SoFieldSensor * planeFieldSensorSoFieldSensor * onFieldSensorSoFieldSensor * draggerPosFieldSensorSoChildList * children
πΈ Protected Attributes inherited from SoNode
uint32_t uniqueId
π Protected Attributes inherited from SoFieldContainer
SbBool isBuiltIn
π 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 }
β Static Protected Attributes inherited from SoNode
static uint32_t nextUniqueId = 0static int nextActionMethodIndex = 0
to be continued bestie... more parts incoming, don't go anywhere π«Ά
π Detailed Description π
okay so bestie, SoClipPlaneManip is literally the class you use to manipulate clip planes. periodt. β¨
Here's the whole vibe: a manipulator gets used by swapping out the node you wanna edit in the graph with the manipulator itself. Then draggers do the actual manipulating. When you're done, the node goes right back into the graph, replacing the manipulator. no cap. π
By default, instances of this manipulator class roll with an SoJackDragger when they're manipulating SoClipPlane nodes. Wanna know how to control the manipulator? Go read the SoJackDragger docs, bestie. π¦
There's an "action shot" of the SoClipPlaneManip (imagine the most iconic screenshot ever, lowkey obsessed). πΈβ¨
This manipulator is an extension compared to the original SGI Inventor v2.1 API. Not only is it a Coin extension, it also shows up in TGS' Inventor implementation (same API, same energy). π
ngl, please note that this manipulator is a bit different from the other manipulators, because it will not automatically scale and translate the dragger to surround the geometry. You have to use the setValue() function to initialize the manipulator/dragger. Below is some example code that loads an Inventor file and adds a clip plane manipulator. π
#include <Inventor/Qt/SoQt.h>
#include <Inventor/Qt/viewers/SoQtExaminerViewer.h>
#include <Inventor/SoDB.h>
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/actions/SoGetBoundingBoxAction.h>
#include <Inventor/SoInput.h>
#include <Inventor/manips/SoClipPlaneManip.h>
#include <assert.h>
// *************************************************************************
int
main(int argc, char ** argv)
{
assert(argc >= 2);
QWidget * window = SoQt::init(argv[0]);
SoQtExaminerViewer * ex = new SoQtExaminerViewer( window );
ex->setBackgroundColor(SbColor(0.1f, 0.3f, 0.5f));
SoInput input;
SbBool ok = input.openFile(argv[1]);
if (!ok) {
fprintf(stderr,"Unable to open file.\n");
return -1;
}
SoSeparator * root = SoDB::readAll(&input);
if (!root) {
fprintf(stderr,"Unable to read file.\n");
return -1;
}
root->ref();
SoGetBoundingBoxAction ba(ex->getViewportRegion());
ba.apply(root);
SbBox3f box = ba.getBoundingBox();
SoClipPlaneManip * manip = new SoClipPlaneManip;
manip->setValue(box, SbVec3f(1.0f, 0.0f, 0.0f), 1.02f);
root->insertChild(manip, 0);
ex->setSceneGraph(root);
ex->show();
SoQt::show( window );
SoQt::mainLoop();
delete ex;
root->unref();
return 0;
}
SinceTGS Inventor 2.5Coin 1.0
π Constructor & Destructor Documentation π
SoClipPlaneManip::SoClipPlaneManip (void )
An SoJackDragger is set up right here as the internal dragger used for manipulation of an SoClipPlane node. πͺ
- References:
children,draggerPosFieldSensor,draggerPosition,fieldSensorCB(),onFieldSensor,planeFieldSensor,setDragger(), andSoClipPlaneManip(). - Referenced by:
copyContents(),fieldSensorCB(),getFieldData(),replaceManip(),SoClipPlaneManip(), andvalueChangedCB().
~SoClipPlaneManip () [protected]
Destructor. π (but make it cute)
- References:
children,draggerPosFieldSensor,onFieldSensor,planeFieldSensor, andsetDragger().
π Member Function Documentation π
okay bestie, this is the whole method tea and we are not skipping a single crumb π β¨
SoType SoClipPlaneManip::getTypeId (void ) const [virtual]
So like, this returns the type identification of an object derived from a class inheriting SoBase. It's giving run-time type checking and "downward" casting, iykyk π¦
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
}
}
For application programmers 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.
Reimplemented from SoClipPlane.
const SoFieldData * SoClipPlaneManip::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. literally just the pointer, bestie π
Reimplemented from SoClipPlane.
References: SoClipPlaneManip().
SoDragger * SoClipPlaneManip::getDragger (void )
Returns pointer to dragger used for interaction. the dragger is the whole vibe check of interaction π
References: children, SoBase::isOfType(), SoDebugError::post(), and SoNode::SoNode().
Referenced by: copyContents(), fieldSensorCB(), setDragger(), and setValue().
void SoClipPlaneManip::setValue (const SbBox3f & box, const SbVec3f & planenormal, float draggerscalefactor)
Sets the clip plane based on the center of box and planenormal. The size of box is used as a scale factor to the dragger, multiplied with draggerscalefactor. math girlies rise πΈ
References: draggerPosition, SoDragger::enableValueChangedCallbacks(), fieldSensorCB(), SbBox3f::getCenter(), getDragger(), SbBox3f::getSize(), SoClipPlane::plane, planeFieldSensor, SoDragger::setMotionMatrix(), and SbMatrix::setScale().
SbBool SoClipPlaneManip::replaceNode (SoPath * path)
Replaces the node specified by path with this manipulator. The manipulator will copy the field data from the node, to make it affect the state in the same way as the node. glow up replacement β¨
References: fieldSensorCB(), SoFullPath::getLength(), SoFullPath::getNodeFromTail(), SoBaseKit::getPart(), SoBaseKit::getPartString(), SoFullPath::getTail(), SoPath::getTail(), SoBase::isOfType(), planeFieldSensor, SoDebugError::post(), SoBase::ref(), SoBaseKit::setPart(), SoClipPlane::SoClipPlane(), SoNode::SoNode(), transferFieldValues(), and SoBase::unrefNoDelete().
SbBool SoClipPlaneManip::replaceManip (SoPath * path, SoClipPlane * newone) const
Replaces this manipulator from the position specified by path with newnode. If newnode is NULL, an SoClipPlane will be created for you. so you don't have to lift a finger π
References: SoClipPlane::SoClipPlane(), and SoClipPlaneManip().
void SoClipPlaneManip::doAction (SoAction * action) [virtual]
This function performs the typical operation of a node for any action. the main character of action methods π
Reimplemented from SoClipPlane.
References: children, and SoAction::getPathCode().
Referenced by: callback(), GLRender(), handleEvent(), pick(), and search().
void SoClipPlaneManip::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. it's giving observer energy π₯
Reimplemented from SoClipPlane.
References: SoClipPlane::callback(), and doAction().
void SoClipPlaneManip::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 SoClipPlane.
References: doAction(), and SoClipPlane::GLRender().
void SoClipPlaneManip::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. bounding box and center coordinates, we love to see it π¦β¨
Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.
Reimplemented from SoNode.
References: children, SoNode::getBoundingBox(), SoGetBoundingBoxAction::getCenter(), SoAction::getPathCode(), SoGetBoundingBoxAction::isCenterSet(), SoGetBoundingBoxAction::resetCenter(), and SoGetBoundingBoxAction::setCenter().
void SoClipPlaneManip::getMatrix (SoGetMatrixAction * action) [virtual]
Action method for SoGetMatrixAction.
Updates action by accumulating with the transformation matrix of this node (if any). matrix math, but make it fashion π
Reimplemented from SoNode.
References: children, and SoAction::getPathCode().
void SoClipPlaneManip::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. event handling bestie, pay attention π
Nodes influencing relevant state variables for how event handling is done also overrides this method.
Reimplemented from SoNode.
References: doAction(), and SoNode::handleEvent().
void SoClipPlaneManip::pick (SoPickAction * action) [virtual]
Action method for SoPickAction.
Does common processing for SoPickAction action instances. picking, but make it systematic π―
Reimplemented from SoClipPlane.
References: doAction(), and SoClipPlane::pick().
void SoClipPlaneManip::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. no half matches, periodt π
See also: SoSearchAction
Reimplemented from SoNode.
References: doAction(), SoSearchAction::isFound(), and SoNode::search().
SoChildList * SoClipPlaneManip::getChildren (void ) const [virtual]
Returns the children of this node. the kids, the heirs, the whole squad π
Reimplemented from SoNode.
References: children.
void SoClipPlaneManip::setDragger (SoDragger * newdragger) [protected]
Sets a dragger to use for this manipulator. The default dragger is an SoJackDragger. default is iconic, ngl π¦
References: SoDragger::addValueChangedCallback(), children, fieldSensorCB(), getDragger(), SoDragger::removeValueChangedCallback(), and valueChangedCB().
Referenced by: copyContents(), SoClipPlaneManip(), and ~SoClipPlaneManip().
void SoClipPlaneManip::copyContents (const SoFieldContainer * from, SbBool copyconnections) [protected], [virtual]
Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE. deep copy realness π
This is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically.
For copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:
SoNode * mynewnode = templatenode->copy();
The same also goes for engines.
Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:
void
MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
SbBool copyconnections)
{
// let parent superclasses do their thing (copy fields, copy
// instance name, etc etc)
SoNode::copyContents(from, copyconnections);
// [..then copy internal data..]
}
Reimplemented from SoNode.
References: SoFieldContainer::copyContents(), getDragger(), SoBase::isOfType(), setDragger(), SoClipPlaneManip(), and SoFieldContainer::SoFieldContainer().
void SoClipPlaneManip::valueChangedCB (void * m, SoDragger * dragger) [static], [protected]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Called whenever dragger is touched. internal tea, bestie π
References: draggerPosition, SoDragger::getMotionMatrix(), SoClipPlane::plane, and SoClipPlaneManip().
Referenced by: setDragger().
void SoClipPlaneManip::fieldSensorCB (void * m, SoSensor * s) [static], [protected]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Called whenever one of the fields changes value. field change notification, we stay notified π
References: draggerPosition, SbPlane::getDistance(), getDragger(), SoDragger::getMotionMatrix(), SbPlane::getNormal(), SbMatrix::getTransform(), onFieldSensor, SoClipPlane::plane, planeFieldSensor, SoDragger::setMotionMatrix(), SbMatrix::setTransform(), SbRotation::setValue(), and SoClipPlaneManip().
Referenced by: replaceNode(), setDragger(), setValue(), and SoClipPlaneManip().
void SoClipPlaneManip::transferFieldValues (const SoClipPlane * from, SoClipPlane * to) [static], [protected]
Copies field values from one clip plane node to another. copy-paste but make it fields π
References: SoClipPlane::on, SoClipPlane::plane, and SoClipPlane::SoClipPlane().
Referenced by: replaceNode().
π Member Data Documentation π
SoSFVec3f SoClipPlaneManip::draggerPosition
okay so bestie, this one is internal to the library β like, it's not likely to be of interest to the application programmer, fr fr. It gets referenced by fieldSensorCB(), setValue(), SoClipPlaneManip(), and valueChangedCB().
SoFieldSensor* SoClipPlaneManip::planeFieldSensor [protected]
same vibe: internal API member, not likely to be of interest to the application programmer. Referenced by fieldSensorCB(), replaceNode(), setValue(), SoClipPlaneManip(), and ~SoClipPlaneManip().
SoFieldSensor* SoClipPlaneManip::onFieldSensor [protected]
yep, internal again β not likely to be of interest to the application programmer. Referenced by fieldSensorCB(), SoClipPlaneManip(), and ~SoClipPlaneManip().
SoFieldSensor* SoClipPlaneManip::draggerPosFieldSensor [protected]
internal API member, not likely to be of interest to the application programmer. Referenced by SoClipPlaneManip(), and ~SoClipPlaneManip().
SoChildList* SoClipPlaneManip::children [protected]
internal API member, not likely to be of interest to the application programmer. Referenced by doAction(), getBoundingBox(), getChildren(), getDragger(), getMatrix(), setDragger(), SoClipPlaneManip(), and ~SoClipPlaneManip().
β¨ Author β¨
Generated automatically by Doxygen for Coin from the source code. π
okay so that's the whole thing! the footer says Coin Version 2.5.0 SoClipPlaneManip(3) β no date on this one, but it's giving timeless icon energy. byeee bestie! π«Άπ
π¦ 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