(Preview feature) [Medical] Shape node that draws the intersection of a plane and a box. More...

#include <Medical/nodes/PlaneBoxIntersection.h>

Inheritance diagram for PlaneBoxIntersection:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	PlaneBoxIntersection ()
	Constructor.

Public Member Functions inherited from SoLineSet
	SoLineSet ()
	Creates a line set node with default settings.

Public Member Functions inherited from SoVertexShape
SoNormalCache *	getNormalCache () const
	Returns the current normal cache, or NULL if there is none.

SoTangentCache *	getTangentCache () const
	Returns the current tangent cache, or NULL if there is none.

Public Member Functions inherited from SoShape
virtual SbBool	affectsState () const
	Overrides default method on SoNode.

ShapeType	getShapeType ()
	Gets the current shape Full Scene Antialiasing type.

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 SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

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 SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (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 void	initClass ()
	Initialize this class.

static void	exitClass ()
	Finish this class.

Static Public Member Functions inherited from SoLineSet
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoNonIndexedShape
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoVertexShape
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoShape
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SbBool	isPrimitiveRestartAvailable (SoState *state=NULL)
	Returns TRUE if the primitive restart feature is available.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (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
SoSFBox3f	box
	3D box to be intersected.

SoSFPlane	plane
	Plane to intersect with.

Public Attributes inherited from SoLineSet
SoMFInt32	numVertices
	Number of vertices per polyline.

Public Attributes inherited from SoNonIndexedShape
SoSFInt32	startIndex
	Index of first coordinate of shape.

Public Attributes inherited from SoVertexShape
SoSFNode	vertexProperty
	vertex property node.

Public Attributes inherited from SoShape
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Additional Inherited Members
Public Types inherited from SoShape
enum	ShapeType { POINTS , LINES , POLYGONS , TEXT }
	Basic type for antialiased rendering for this shape (Do not consider the SoDrawStyle property currently in the state). More...

Detailed Description

(Preview feature) [Medical] Shape node that draws the intersection of a plane and a box.

This node is useful for highlighting. The intersection of a plane and a box in the general case is a polygon with up to six points. If the plane does not intersect the box, nothing is drawn.

This node is particularly useful for highlighting the location of a clip plane (using the bounding box of the geometry) and for highlighting the outline of an oblique slice (SoObliqueSlice) using the bounding box (extent) of the volume. The plane field may be automatically updated from a dragger or another node such as SoClipPlane or SoObliqueSlice using the connectFrom() method.

This node is derived from SoLineSet, but the standard fields of that class (numVertices, startIndex and vertexProperty) are managed internally and should not be modified by the application.

The color, line width, etc of the intersection lines can be set using SoMaterial, SoDrawStyle, etc nodes in the usual way.

FILE FORMAT/DEFAULT

PlaneBoxIntersection

plane	1 0 0 0
box	0 0 0 0 0 0

Constructor & Destructor Documentation

◆ PlaneBoxIntersection()

PlaneBoxIntersection::PlaneBoxIntersection ( )

Constructor.

Member Function Documentation

◆ exitClass()

static void PlaneBoxIntersection::exitClass ( )

static

Finish this class.

◆ getClassTypeId()

static SoType PlaneBoxIntersection::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType PlaneBoxIntersection::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoLineSet.

◆ initClass()

static void PlaneBoxIntersection::initClass ( )

static

Initialize this class.

Member Data Documentation

◆ box

SoSFBox3f PlaneBoxIntersection::box

3D box to be intersected.

Default is an empty box.

Definition at line 79 of file PlaneBoxIntersection.h.

◆ plane

SoSFPlane PlaneBoxIntersection::plane

Plane to intersect with.

Default is plane with normal vector 1,0,0 at distance 0.

Definition at line 83 of file PlaneBoxIntersection.h.

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

Medical/nodes/PlaneBoxIntersection.h

Open Inventor Release 2024.2.1

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

FILE FORMAT/DEFAULT

SEE ALSO

Constructor & Destructor Documentation

◆ PlaneBoxIntersection()

Member Function Documentation

◆ exitClass()

◆ getClassTypeId()

◆ getTypeId()

◆ initClass()

Member Data Documentation

◆ box

◆ plane