Coin  4.0.3
Coin3D core library
Loading...
Searching...
No Matches
SoClipPlaneManip Class Reference

The SoClipPlaneManip class is used to manipulate clip planes. More...

#include <Inventor/manips/SoClipPlaneManip.h>

Inheritance diagram for SoClipPlaneManip:
SoClipPlane SoNode SoFieldContainer SoBase

Public Member Functions

 SoClipPlaneManip (void)
 
virtual void callback (SoCallbackAction *action)
 
virtual void doAction (SoAction *action)
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
virtual SoChildListgetChildren (void) const
 
SoDraggergetDragger (void)
 
virtual void getMatrix (SoGetMatrixAction *action)
 
virtual SoType getTypeId (void) const
 
virtual void GLRender (SoGLRenderAction *action)
 
virtual void handleEvent (SoHandleEventAction *action)
 
virtual void pick (SoPickAction *action)
 
SbBool replaceManip (SoPath *p, SoClipPlane *newone) const
 
SbBool replaceNode (SoPath *p)
 
virtual void search (SoSearchAction *action)
 
void setValue (const SbBox3f &box, const SbVec3f &planenormal, float draggerscalefactor)
 
- Public Member Functions inherited from SoClipPlane
 SoClipPlane (void)
 
- Public Member Functions inherited from SoNode
virtual SoNodeaddToCopyDict (void) const
 
virtual SbBool affectsState (void) const
 
virtual void audioRender (SoAudioRenderAction *action)
 
virtual SoNodecopy (SbBool copyconnections=FALSE) const
 
virtual SoFieldContainercopyThroughConnection (void) const
 
SbUniqueId getNodeId (void) const
 
NodeType getNodeType (void) const
 
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
 
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 
virtual void GLRenderInPath (SoGLRenderAction *action)
 
virtual void GLRenderOffPath (SoGLRenderAction *action)
 
virtual void grabEventsCleanup (void)
 
virtual void grabEventsSetup (void)
 
SbBool isOverride (void) const
 
virtual void notify (SoNotList *l)
 
virtual void rayPick (SoRayPickAction *action)
 
void setNodeType (const NodeType type)
 
void setOverride (const SbBool state)
 
virtual void startNotify (void)
 
virtual void write (SoWriteAction *action)
 
virtual void writeInstance (SoOutput *out)
 
- Public Member Functions inherited from SoFieldContainer
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
 
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
 
SbBool enableNotify (const SbBool flag)
 
SbBool fieldsAreEqual (const SoFieldContainer *container) const
 
void get (SbString &fielddata)
 
void get (SbString &fielddata, SoOutput *out)
 
virtual int getAllFields (SoFieldList &l) const
 
virtual SoFieldgetEventIn (const SbName &name) const
 
virtual SoFieldgetEventOut (const SbName &name) const
 
virtual SoFieldgetField (const SbName &name) const
 
SbBool getFieldName (const SoField *const field, SbName &name) const
 
virtual int getFields (SoFieldList &l) const
 
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
 
SbBool getIsBuiltIn (void) const
 
voidgetUserData (void) const
 
SbBool hasDefaultValues (void) const
 
SbBool isNotifyEnabled (void) const
 
SbBool set (const char *const fielddata)
 
SbBool set (const char *fielddata, SoInput *input)
 
void setToDefaults (void)
 
void setUserData (void *userdata) const
 
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
 
- Public Member Functions inherited from SoBase
void addAuditor (void *const auditor, const SoNotRec::Type type)
 
void assertAlive (void) const
 
const SoAuditorListgetAuditors (void) const
 
virtual SbName getName (void) const
 
int32_t getRefCount (void) const
 
SbBool isOfType (SoType type) const
 Returns TRUE if the type of this object is either of the same type or inherited from type.
 
void ref (void) const
 
void removeAuditor (void *const auditor, const SoNotRec::Type type)
 
virtual void setName (const SbName &newname)
 
SbBool shouldWrite (void)
 
void touch (void)
 
void unref (void) const
 
void unrefNoDelete (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.
 
- 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 void audioRenderS (SoAction *action, SoNode *node)
 
static void callbackS (SoAction *action, SoNode *node)
 
static int getActionMethodIndex (const SoType type)
 
static void getBoundingBoxS (SoAction *action, SoNode *node)
 
static SoNodegetByName (const SbName &name)
 
static int getByName (const SbName &name, SoNodeList &l)
 
static SoType getClassTypeId (void)
 
static uint32_t getCompatibilityTypes (const SoType &nodetype)
 
static void getMatrixS (SoAction *action, SoNode *node)
 
static SbUniqueId getNextNodeId (void)
 
static void getPrimitiveCountS (SoAction *action, SoNode *node)
 
static void GLRenderS (SoAction *action, SoNode *node)
 
static void handleEventS (SoAction *action, SoNode *node)
 
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 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 Public Member Functions inherited from SoFieldContainer
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 
static void cleanupClass (void)
 
static void copyDone (void)
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, const SbBool copyconnections)
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
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 initCopyDict (void)
 
- Static Public Member Functions inherited from SoBase
static void addName (SoBase *const base, const char *const name)
 
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
 
static void decrementCurrentWriteCounter (void)
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static SoBasegetNamedBase (const SbName &name, SoType type)
 
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
 
static SbBool getTraceRefs (void)
 
static void incrementCurrentWriteCounter (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 SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
 
static SbBool readRoute (SoInput *input)
 
static void removeName (SoBase *const base, const char *const name)
 
static void setInstancePrefix (const SbString &c)
 
static void setTraceRefs (SbBool trace)
 

Public Attributes

SoSFVec3f draggerPosition
 
- Public Attributes inherited from SoClipPlane
SoSFBool on
 
SoSFPlane plane
 

Protected Member Functions

virtual ~SoClipPlaneManip (void)
 
virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
 
virtual const SoFieldDatagetFieldData (void) const
 
void setDragger (SoDragger *newdragger)
 
- 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 SoNotRec createNotRec (void)
 
virtual void destroy (void)
 
virtual const char * getFileFormatName (void) const
 
SbBool hasMultipleWriteRefs (void) const
 
void writeFooter (SoOutput *out) const
 
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
 

Static Protected Member Functions

static void fieldSensorCB (void *f, SoSensor *d)
 
static const SoFieldData ** getFieldDataPtr (void)
 
static void transferFieldValues (const SoClipPlane *from, SoClipPlane *to)
 
static void valueChangedCB (void *f, SoDragger *d)
 
- 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 int getNextActionMethodIndex (void)
 
static void incNextActionMethodIndex (void)
 
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)
 
static void setNextActionMethodIndex (int index)
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter (void)
 
static void staticDataLock (void)
 
static void staticDataUnlock (void)
 

Protected Attributes

SoChildListchildren
 
SoFieldSensordraggerPosFieldSensor
 
SoFieldSensoronFieldSensor
 
SoFieldSensorplaneFieldSensor
 
- 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 int nextActionMethodIndex = 0
 
static SbUniqueId nextUniqueId = 1
 

Detailed Description

The SoClipPlaneManip class is used to manipulate clip planes.

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.

Example of ClipPlane Manipulator

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.

An "action shot" of the SoClipPlaneManip:

Action Shot of ClipPlane Manipulator

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

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.

#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]);
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();
manip->setValue(box, SbVec3f(1.0f, 0.0f, 0.0f), 1.02f);
root->insertChild(manip, 0);
ex->setSceneGraph(root);
ex->show();
SoQt::show( window );
delete ex;
root->unref();
return 0;
}
The SbBox3f class is an abstraction for an axis aligned 3 dimensional box.
Definition SbBox3f.h:46
The SbColor class contains the red, green and blue components which make up a color value.
Definition SbColor.h:39
The SbList class is a template container class for lists.
Definition SbList.h:70
SbList(const int sizehint=DEFAULTSIZE)
Definition SbList.h:78
The SbVec3f class is a 3 dimensional vector with floating point coordinates.
Definition SbVec3f.h:51
void unref(void) const
Definition SoBase.cpp:530
void ref(void) const
Definition SoBase.cpp:478
The SoClipPlaneManip class is used to manipulate clip planes.
Definition SoClipPlaneManip.h:49
SoClipPlaneManip(void)
Definition SoClipPlaneManip.cpp:205
static SoSeparator * readAll(SoInput *input)
Definition SoDB.cpp:682
The SoGetBoundingBoxAction class calculates bounding boxes for nodes and subgraphs.
Definition SoGetBoundingBoxAction.h:45
virtual void insertChild(SoNode *child, int newchildindex)
Definition SoGroup.cpp:470
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
virtual SbBool openFile(const char *fileName, SbBool okIfNotFound=FALSE)
Definition SoInput.cpp:495
The SoSeparator class is a state-preserving group node.
Definition SoSeparator.h:44
Since
TGS Inventor 2.5
Coin 1.0

Constructor & Destructor Documentation

◆ SoClipPlaneManip()

SoClipPlaneManip::SoClipPlaneManip ( void )

An SoJackDragger is set up here as the internal dragger used for manipulation of an SoClipPlane node.

◆ ~SoClipPlaneManip()

SoClipPlaneManip::~SoClipPlaneManip ( void )
protectedvirtual

Destructor.

Member Function Documentation

◆ callback()

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.

◆ copyContents()

void SoClipPlaneManip::copyContents ( const SoFieldContainer * from,
SbBool copyconnections )
protectedvirtual

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:

void copy(const SbList< Type > &l)
Definition SbList.h:92
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56

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,
{
// let parent superclasses do their thing (copy fields, copy
// instance name, etc.)
// [..then copy internal data..]
}
The SoFieldContainer class is a base class for all classes that contain fields.
Definition SoFieldContainer.h:43
virtual void copyContents(const SoFieldContainer *from, SbBool copyconnections)
Definition SoNode.cpp:1483

Reimplemented from SoNode.

◆ doAction()

void SoClipPlaneManip::doAction ( SoAction * action)
virtual

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

Reimplemented from SoClipPlane.

◆ fieldSensorCB()

void SoClipPlaneManip::fieldSensorCB ( void * m,
SoSensor * sensor )
staticprotected

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.

◆ getBoundingBox()

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.

◆ getChildren()

SoChildList * SoClipPlaneManip::getChildren ( void ) const
virtual

Returns the children of this node.

Reimplemented from SoNode.

◆ getClassTypeId()

SoType SoClipPlaneManip::getClassTypeId ( void )
static

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

◆ getDragger()

SoDragger * SoClipPlaneManip::getDragger ( void )

Returns pointer to dragger used for interaction.

◆ getFieldData()

const SoFieldData * SoClipPlaneManip::getFieldData ( void ) const
protectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoClipPlane.

◆ getFieldDataPtr()

const SoFieldData ** SoClipPlaneManip::getFieldDataPtr ( void )
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

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

◆ getMatrix()

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.

◆ getTypeId()

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.

Reimplemented from SoClipPlane.

◆ GLRender()

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.

Reimplemented from SoClipPlane.

◆ handleEvent()

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.

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

Reimplemented from SoNode.

◆ pick()

void SoClipPlaneManip::pick ( SoPickAction * action)
virtual

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoClipPlane.

◆ replaceManip()

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.

◆ replaceNode()

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.

◆ search()

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.

See also
SoSearchAction

Reimplemented from SoNode.

◆ setDragger()

void SoClipPlaneManip::setDragger ( SoDragger * newdragger)
protected

Sets a dragger to use for this manipulator. The default dragger is an SoJackDragger.

◆ setValue()

void SoClipPlaneManip::setValue ( const SbBox3f & box,
const SbVec3f & planenormal,
float draggerscalefactor )

Sets the clip plane based on the center of box and normal. The size of box is used as a scale factor to the dragger, multiplied with draggerscalefactor.

◆ transferFieldValues()

void SoClipPlaneManip::transferFieldValues ( const SoClipPlane * from,
SoClipPlane * to )
staticprotected

Copies field values from one clip plane node to another.

◆ valueChangedCB()

void SoClipPlaneManip::valueChangedCB ( void * m,
SoDragger * dragger )
staticprotected

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.

Member Data Documentation

◆ children

SoChildList * SoClipPlaneManip::children
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ draggerPosFieldSensor

SoFieldSensor * SoClipPlaneManip::draggerPosFieldSensor
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ draggerPosition

SoSFVec3f * SoClipPlaneManip::draggerPosition

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ onFieldSensor

SoFieldSensor * SoClipPlaneManip::onFieldSensor
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ planeFieldSensor

SoFieldSensor * SoClipPlaneManip::planeFieldSensor
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.


The documentation for this class was generated from the following files: