Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
SoClipPlaneManip Class Reference

VSG extension Manipulator to transform a clipping plane. More...

#include <Inventor/manips/SoClipPlaneManip.h>

+ Inheritance diagram for SoClipPlaneManip:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoClipPlaneManip ()
 Constructor.
 
SoDraggergetDragger ()
 Returns the dragger node being employed by this manip.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
void setValue (const SbBox3f &box, const SbVec3f &planeNormal, float draggerScaleFactor)
 Convenience method to set the clip plane and the dragger position, orientation and size.
 
SbBool replaceNode (SoPath *p)
 Replaces a regular SoClipPlane node with this manipulator.
 
SbBool replaceManip (SoPath *p, SoClipPlane *newOne) const
 Replaces this manipulator with a regular SoClipPlane node.
 
- Public Member Functions inherited from SoClipPlane
 SoClipPlane ()
 Creates a clip plane node with default settings.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoClipPlane
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoSFVec3f draggerPosition
 Dragger position.
 
- Public Attributes inherited from SoClipPlane
SoSFPlane plane
 Plane defining half-space.
 
SoSFBool on
 Whether clipping plane is active.
 

Detailed Description

VSG extension Manipulator to transform a clipping plane.

This class defines a manipulator to transform a clipping plane. An SoJackDragger allows the user to rotate and translate the clipping plane.

This node clips all subsequent shapes in the scene graph to the half-space defined by the plane field. The half-space that is rendered is on the side of the plane in the direction of the plane normal. The half-space that is clipped away is on the side of the plane opposite the direction of the plane normal. For example, if the plane normal is 0,0,1 (pointing in the positive Z direction), then everything in the negative Z direction will be clipped away.

FILE FORMAT/DEFAULT

    ClipPlaneManip {
    plane 1 0 0 0
    on TRUE
    draggerPosition 0 0 0
    }

SEE ALSO

SoClipPlane, SoDragger

Definition at line 66 of file SoClipPlaneManip.h.

Constructor & Destructor Documentation

◆ SoClipPlaneManip()

SoClipPlaneManip::SoClipPlaneManip ( )

Constructor.

Member Function Documentation

◆ copy()

virtual SoNode * SoClipPlaneManip::copy ( SbBool  copyConnections = FALSE) const
virtual

Creates and returns an exact copy of the node.

If the node is a group, it copies the children as well. If copyConnections is TRUE (it is FALSE by default), any connections to (but not from) fields of the node are copied, as well. Note that multiple references to a node under the node to be copied will result in multiple references to the copy of that node. To be copyable, a custom node must define a default contructor. Note that OIV require that every custom node must define a default contructor.

Please also note that instance data other than Inventor fields and public children will not be copied by this method. If extra data needs to be copied as well, this method will have to be manually overridden.

Reimplemented from SoNode.

◆ getClassTypeId()

static SoType SoClipPlaneManip::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getDragger()

SoDragger * SoClipPlaneManip::getDragger ( )

Returns the dragger node being employed by this manip.

◆ getTypeId()

virtual SoType SoClipPlaneManip::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoClipPlane.

◆ replaceManip()

SbBool SoClipPlaneManip::replaceManip ( SoPath p,
SoClipPlane newOne 
) const

Replaces this manipulator with a regular SoClipPlane node.

◆ replaceNode()

SbBool SoClipPlaneManip::replaceNode ( SoPath p)

Replaces a regular SoClipPlane node with this manipulator.

◆ setValue()

void SoClipPlaneManip::setValue ( const SbBox3f box,
const SbVec3f planeNormal,
float  draggerScaleFactor 
)

Convenience method to set the clip plane and the dragger position, orientation and size.

The clip plane will be the plane defined by planeNormal and the point at the center of box .

The dragger will be positioned at the center of box . The size of the dragger geometry will be the default size multiplied by a scale factor. This scale factor is the largest dimension of box multiplied by draggerScaleFactor . The default extent of the main part of SoJackDragger is 2, because it extends from -1 to 1 (note that the "arms" of this dragger extend further). Therefore to make the dragger fit inside the specified box, the draggerScaleFactor parameter should be set to 0.5.

Member Data Documentation

◆ draggerPosition

SoSFVec3f SoClipPlaneManip::draggerPosition

Dragger position.

Definition at line 81 of file SoClipPlaneManip.h.


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