SoClipPlaneManip(3)

📦

version 4.0.10 · 4 versions

4.0.10 · fedora 43, fedora 44 (latest)
4.0.10 · epel 9
4.0.3 · fedora 43
4.0.7 · fedora 44

💖 SoClipPlaneManip(3) — the Coin manual page, bestie edition 💖

okay so. welcome to the SoClipPlaneManip man page, part of Coin (that's the 3D graphics toolkit, iykyk). this is the class that lets you manipulate clip planes — like, actually grab them and drag them around with a dragger. no cap. it's giving interactive plane vibes. 🎀

✨ NAME ✨

SoClipPlaneManip — this class is used to manipulate clip planes. that's it, that's the whole job. she's a specialist. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/manips/SoClipPlaneManip.h>

Inherits SoClipPlane.

🦋 Public Member Functions 🦋

virtual SoType getTypeId (void) const
SoClipPlaneManip (void)
SoDragger * getDragger (void)
void setValue (const SbBox3f &box, const SbVec3f &planenormal, float draggerscalefactor)
SbBool replaceNode (SoPath *p)
SbBool replaceManip (SoPath *p, SoClipPlane *newone) const
virtual 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) 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 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)
SbUniqueId 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 — Returns TRUE if the type of this object is either of the same type or inherited from type.
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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. (the classy little setup moment ✨)

⭐ Static Public Member Functions inherited from `SoClipPlane`

static SoType getClassTypeId (void)
static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

⭐ 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
static void initClasses (void)
static SbUniqueId 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
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 🫶

SoSFVec3f draggerPosition

🫶 Public Attributes inherited from `SoClipPlane`

SoSFPlane plane
SoSFBool on

🌈 Protected Member Functions 🌈

virtual const SoFieldData * getFieldData (void) const
virtual ~SoClipPlaneManip (void)
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)
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
virtual SoNotRec createNotRec (void)

🧚 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 * planeFieldSensor
SoFieldSensor * onFieldSensor
SoFieldSensor * draggerPosFieldSensor
SoChildList * children

🔥 Protected Attributes inherited from `SoNode`

SbUniqueId 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,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

💀 Protected Types inherited from `SoBase`

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

💀 Static Protected Attributes inherited from `SoNode`

static SbUniqueId nextUniqueId = 1
static int nextActionMethodIndex = 0

okay bestie that's part 1 — more of this iconic page is coming up next, don't go anywhere 💖✨

✨ Detailed Description ✨

okay so bestie, listen up 💖 the SoClipPlaneManip class is used to manipulate clip planes. that's the whole assignment, and it ate.

A manipulator is used by replacing the node you want to edit in the graph with the manipulator. Draggers are used to manipulate the node. When manipulation is finished, the node is put back into the graph, replacing the manipulator. it's giving temporary main character, then it hands the crown back 👑

An SoJackDragger is used by instances of this manipulator class as the default dragger when manipulating SoClipPlane nodes. See the documentation of SoJackDragger for details about how to control the manipulator. iykyk 🦋

An "action shot" of the SoClipPlaneManip:

This manipulator is an extension versus the original SGI Inventor v2.1 API. In addition to being a Coin extension, it is also present in TGS' Inventor implementation (with the same API). slay ✨

🚨 PLEASE READ THIS ONE, FR FR 🚨 Please note that this manipulator is a bit different than the other manipulators, since it will not automatically scale and translate the dragger to surround the geometry. The setValue() function must be used to initialize the manipulator/dragger. Below you'll find some example code that loads an Inventor file and adds a clip plane manipulator. no cap, you literally have to call setValue(), she will not figure it out herself 🙈

#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 <cassert>

// *************************************************************************

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;
}

🌱 Since 🌱

TGS Inventor 2.5
Coin 1.0

🎀 Constructor & Destructor Documentation 🎀

`SoClipPlaneManip::SoClipPlaneManip (void )`

An SoJackDragger is set up here as the internal dragger used for manipulation of an SoClipPlane node. she comes with her own dragger pre-installed, iconic behavior 💅

`SoClipPlaneManip::~SoClipPlaneManip (void )` [protected], [virtual]

Destructor. bye bestie 🫶

👑 Member Function Documentation 👑

`SoType SoClipPlaneManip::getClassTypeId (void )` [static]

This static method returns the SoType object associated with objects of this class.

`SoType SoClipPlaneManip::getTypeId (void ) const` [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. the vibe check of C++ ✨

Reimplemented from SoClipPlane.

`const SoFieldData ** SoClipPlaneManip::getFieldDataPtr (void )` [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. (translation: not your business, bestie, move along)

Returns the SoFieldData class which holds information about fields in this node.

`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. empty-handed, respectfully 💀

Reimplemented from SoClipPlane.

`SoDragger * SoClipPlaneManip::getDragger (void )`

Returns pointer to dragger used for interaction. that's her little helper 🎀

`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. this is THE function, the one you cannot skip, remember? 🌸

`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. stealing the fit but keeping it identical 👑

`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. 🫶 the code has your back

`void SoClipPlaneManip::doAction (SoAction * action)` [virtual]

This function performs the typical operation of a node for any action.

Reimplemented from SoClipPlane.

`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.

Reimplemented from SoClipPlane.

`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 want to throw geometry primitives at OpenGL override this method. throwing geometry primitives at OpenGL is such a mood ngl 🔥

Reimplemented from SoClipPlane.

`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.

Nodes influencing how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoNode.

`void SoClipPlaneManip::getMatrix (SoGetMatrixAction * action)` [virtual]

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoNode.

`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. not me ignoring everything that isn't about me 💅

Nodes influencing relevant state variables for how event handling is done also override this method.

Reimplemented from SoNode.

`void SoClipPlaneManip::pick (SoPickAction * action)` [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoClipPlane.

`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. one miss and it's over for you 😭

See also: SoSearchAction

Reimplemented from SoNode.

`SoChildList * SoClipPlaneManip::getChildren (void ) const` [virtual]

Returns the children of this node. the little ones 🦋

Reimplemented from SoNode.

`void SoClipPlaneManip::setDragger (SoDragger * newdragger)` [protected]

Sets a dragger to use for this manipulator. The default dragger is an SoJackDragger. swap her out if you want, no judgment ✨

`void SoClipPlaneManip::copyContents (const SoFieldContainer * from, SbBool copyconnections)` [protected], [virtual]

Makes a deep copy of all data of from into this instance, except external scene graph references if copyconnections is FALSE.

This is the method that should be overridden by extension node / engine / dragger / whatever subclasses which need 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 its 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.)
  SoNode::copyContents(from, copyconnections);

  // [..then copy internal data..]
}

call your parents, they know things 🫶

Reimplemented from SoNode.