MRML node to represent three clipping planes. More...

#include <Libs/MRML/Core/vtkMRMLClipNode.h>

Inheritance diagram for vtkMRMLClipNode:

[legend]

Collaboration diagram for vtkMRMLClipNode:

[legend]

Public Types
enum	{ ClipNodeModifiedEvent = 53001 }

enum	ClippingMethodType { Straight = 0 , WholeCells , WholeCellsWithBoundary }

enum	ClippingStateType { ClipOff = 0 , ClipPositiveSpace = 1 , ClipNegativeSpace = 2 }
	Clipping state for each clipping node reference. More...

enum	ClipTypeType { ClipIntersection = 0 , ClipUnion = 1 }

typedef vtkMRMLNode	Superclass

Public Types inherited from vtkMRMLNode
enum	{ HierarchyModifiedEvent = 16000 , IDChangedEvent = 16001 , ReferenceAddedEvent , ReferenceModifiedEvent , ReferenceRemovedEvent , ReferencedNodeModifiedEvent }

enum	ContentModifiedObserveType { ContentModifiedObserveUndefined = -1 , ContentModifiedObserveDisabled = 0 , ContentModifiedObserveEnabled = 1 }

typedef std::map< std::string, std::string >	ReferencePropertiesType
	Get the node reference properties for a specific referenceRole.

typedef vtkObject	Superclass

Public Member Functions
void	AddAndObserveClippingNodeID (const char *clippingNodeID)

void	CopyReferences (vtkMRMLNode *node) override
	Overridden to update the implicit function when the clipping nodes are modified.

vtkMRMLNode *	CreateNodeInstance () override
	MRMLNode methods.

virtual const char *	GetClassName ()

virtual int	GetClippingMethod ()

vtkMRMLNode *	GetClippingNode ()

const char *	GetClippingNodeID ()

int	GetClippingNodeIndex (const char *nodeID)
	Get or set the clipping node index.

int	GetClippingNodeIndexFromID (const char *clippingNodeID)
	Get the index of the clipping node.

const char *	GetClippingNodeReferenceRole () const
	Node reference role used for storing clip plane node references.

int	GetClippingNodeState (const char *nodeID)

int	GetClippingNodeState (vtkMRMLNode *node)

bool	GetClippingPlanes (vtkPlaneCollection planeCollection, bool invert=false, vtkMRMLMessageCollection messages=nullptr)

int	GetClipType ()

int	GetGreenSliceClipState ()

vtkImplicitFunction *	GetImplicitFunctionWorld ()
	Get the implicit function that represents the clipping function created from the referenced clipping nodes.

const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model)

vtkMRMLNode *	GetNthClippingNode (int n)
	Get the clipping node.

const char *	GetNthClippingNodeID (int n)
	Get the clip plane node ID.

int	GetNthClippingNodeState (int n)

int	GetNumberOfClippingNodes ()
	Get the number of clip plane nodes.

void	GetPlanes (vtkPlaneCollection *planes)
	Get all the plane implicit functions from the clipping nodes.

int	GetRedSliceClipState ()

int	GetYellowSliceClipState ()

bool	HasClippingNodeID (const char *clippingNodeID)
	Check if the clip plane node ID exists.

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	ProcessMRMLEvents (vtkObject caller, unsigned long event, void callData) override
	Overridden to update the implicit function when the clipping nodes are modified.

void	ReadXMLAttributes (const char **atts) override
	Read node attributes from XML file.

void	RemoveAllClippingNodeIDs ()

void	RemoveClippingNodeID (const char *clippingNodeID)
	Remove the clip plane node.

void	RemoveNthClippingNodeID (int n)

void	SetAndObserveClippingNodeID (const char *clippingNodeID)

void	SetAndObserveNthClippingNodeID (int n, const char *clippingNodeID)

virtual void	SetClippingMethod (int)

void	SetClippingNodeState (const char *nodeID, int)

void	SetClippingNodeState (vtkMRMLNode *, int)

void	SetClipType (int clipType)

void	SetGreenSliceClipState (int)

void	SetNthClippingNodeState (int n, int state)

void	SetRedSliceClipState (int)

void	SetYellowSliceClipState (int)

	vtkMRMLCopyContentMacro (vtkMRMLClipNode)

void	WriteXML (ostream &of, int indent) override
	Write this node's information to a MRML file in XML format.

Public Member Functions inherited from vtkMRMLNode
vtkMRMLNode *	AddAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Add and observe a reference node from this node for a specific referenceRole.

vtkMRMLNode *	AddNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Convenience method that adds a referencedNodeID at the end of the list.

void	AddNodeReferenceRole (const char referenceRole, const char mrmlAttributeName=nullptr, vtkIntArray *events=nullptr, bool observeContentModifiedEvents=false)
	Add a referenceRole.

virtual void	AddToSceneOff ()

virtual void	AddToSceneOn ()

void	ClearNodeReferenceProperties (const std::string &referenceRole)
	Remove all node reference properties for a specific referenceRole.

void	ClearNthNodeReferenceProperties (const std::string &referenceRole, int n)

virtual void	Copy (vtkMRMLNode *node)
	Copy node contents from another node of the same type. Does not copy node ID and Scene. Performs deep copy - an independent copy is created from all data, including bulk data.

virtual void	CopyContent (vtkMRMLNode *node, bool deepCopy=true)
	Copy node contents from another node of the same type. Does not copy node ID, Scene, Name, SingletonTag, HideFromEditors, AddToScene, UndoEnabled, and node references. If deepCopy is set to false then a shallow copy of bulk data (such as image or mesh data) could be made; copying may be faster but the node may share some data with the source node instead of creating an independent copy.

void	CopyWithScene (vtkMRMLNode *node)
	Copy everything (including Scene and ID) from another node of the same type.

void	DisableModifiedEventOff ()

void	DisableModifiedEventOn ()

virtual int	EndModify (int previousDisableModifiedEventState)
	End modifying the node.

virtual int	GetAddToScene ()
	node added to MRML scene.

const char *	GetAttribute (const char *name)
	Get value of a name value pair attribute.

std::vector< std::string >	GetAttributeNames ()
	Get all attribute names.

void	GetAttributeNames (vtkStringArray *attributeNames)
	Get all attribute names. Python-wrappable version.

virtual vtkIntArray *	GetContentModifiedEvents ()

int	GetCustomModifiedEventPending (int eventId)

virtual std::string	GetDefaultNodeNamePrefix ()

virtual char *	GetDescription ()

virtual int	GetDisableModifiedEvent ()
	Turn on/off generating InvokeEvent for set macros.

virtual int	GetHideFromEditors ()
	Describes if the node is hidden.

virtual char *	GetID ()
	ID use by other nodes to reference this node in XML.

virtual int	GetInMRMLCallbackFlag ()
	Flags to avoid event loops.

virtual int	GetModifiedEventPending ()

virtual char *	GetName ()

vtkMRMLNode *	GetNodeReference (const char *referenceRole)

const char *	GetNodeReferenceID (const char *referenceRole)
	Utility function that returns the first node id for a specific referenceRole.

void	GetNodeReferenceIDs (const char referenceRole, std::vector< const char > &referencedNodeIDs)
	Return a list of the referenced node IDs.

const ReferencePropertiesType *	GetNodeReferenceProperties (const char *referenceRole)

std::string	GetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
	Get the node reference property for a specific referenceRole.

std::string	GetNodeReferencePropertyName (const std::string &referenceRole, int propertyIndex)
	Get the name of the Nth node reference property for a specific referenceRole.

std::vector< std::string >	GetNodeReferencePropertyNames (const std::string &referenceRole)
	Get the names of all node reference properties for a specific referenceRole.

void	GetNodeReferenceRoles (std::vector< std::string > &roles)

void	GetNodeReferences (const char referenceRole, std::vector< vtkMRMLNode > &nodes)
	Return a list of the referenced nodes.

vtkMRMLNode *	GetNthNodeReference (const char *referenceRole, int n)
	Get referenced MRML node for a specific referenceRole.

const char *	GetNthNodeReferenceID (const char *referenceRole, int n)
	Return the string of the Nth node ID for a specific reference role.

const ReferencePropertiesType *	GetNthNodeReferenceProperties (const char *referenceRole, int n)

std::string	GetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)

std::string	GetNthNodeReferencePropertyName (const std::string &referenceRole, int referenceIndex, int propertyIndex)

std::vector< std::string >	GetNthNodeReferencePropertyNames (const std::string &referenceRole, int n)

const char *	GetNthNodeReferenceRole (int n)

int	GetNumberOfNodeReferenceProperties (const std::string &referenceRole)
	Get the number of node reference properties for a specific referenceRole.

int	GetNumberOfNodeReferenceRoles ()

int	GetNumberOfNodeReferences (const char *referenceRole)
	Return the number of node IDs for a specific reference role (and nodes as they always have the same size).

int	GetNumberOfNthNodeReferenceProperties (const std::string &referenceRole, int n)

virtual int	GetSaveWithScene ()
	Save node with MRML scene.

virtual vtkMRMLScene *	GetScene ()
	Get the scene this node has been added to.

virtual int	GetSelectable ()
	Describes if the node is selectable.

virtual int	GetSelected ()
	Get/Set for Selected.

virtual char *	GetSingletonTag ()

virtual std::string	GetTypeDisplayName ()

virtual bool	GetUndoEnabled ()

virtual bool	HasCopyContent () const
	Returns true if the class supports deep and shallow copying node content.

bool	HasNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Return true if referencedNodeID is in the node ID list for a specific referenceRole.

virtual void	HideFromEditorsOff ()

virtual void	HideFromEditorsOn ()

virtual void	InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
	This method allows the node to compress events.

virtual int	InvokePendingModifiedEvent ()
	Invokes any modified events that are `pending`.

bool	IsSingleton ()

void	Modified () override
	Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent.

virtual void	OnNodeAddedToScene ()

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	ProcessChildNode (vtkMRMLNode *)
	Set dependencies between this node and a child node when parsing XML file.

void	RemoveAttribute (const char *name)
	Remove attribute with the specified name.

void	RemoveNodeReferenceIDs (const char *referenceRole)
	Remove all node IDs and associated nodes for a specific referenceRole.

void	RemoveNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
	Remove a node reference property for a specific referenceRole.

void	RemoveNthNodeReferenceID (const char *referenceRole, int n)
	Convenience method that removes the Nth node ID from the list.

void	RemoveNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)

virtual void	Reset (vtkMRMLNode *defaultNode)
	Reset node attributes to the initial state as defined in the constructor or the passed default node.

virtual void	SaveWithSceneOff ()

virtual void	SaveWithSceneOn ()

virtual void	SelectableOff ()

virtual void	SelectableOn ()

virtual void	SelectedOff ()

virtual void	SelectedOn ()

virtual void	SetAddToScene (int)

void	SetAddToSceneNoModify (int value)

vtkMRMLNode *	SetAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Set and observe a reference node from this node for a specific referenceRole.

vtkMRMLNode *	SetAndObserveNthNodeReferenceID (const char referenceRole, int n, const char referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Set and observe the Nth node ID for a specific reference role.

void	SetAttribute (const char name, const char value)
	Set a name value pair attribute.

virtual void	SetDefaultNodeNamePrefix (const std::string &prefix)

virtual void	SetDescription (const char *)
	Text description of this node, to be set by the user.

void	SetDisableModifiedEvent (int onOff)

virtual void	SetHideFromEditors (int)

void	SetInMRMLCallbackFlag (int flag)

virtual void	SetName (const char *)
	Name of this node, to be set by the user.

vtkMRMLNode *	SetNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Set a reference to a node with specified nodeID from this node for a specific referenceRole.

void	SetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName, const std::string &value)
	Set the node reference property for a specific referenceRole.

vtkMRMLNode *	SetNthNodeReferenceID (const char referenceRole, int n, const char referencedNodeID)
	Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole.

void	SetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName, const std::string &value)

virtual void	SetSaveWithScene (int)

virtual void	SetScene (vtkMRMLScene *scene)
	This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene.

virtual void	SetSceneReferences ()
	Update the references of the node to the scene.

virtual void	SetSelectable (int)

virtual void	SetSelected (int)

void	SetSingletonOff ()

void	SetSingletonOn ()

virtual void	SetSingletonTag (const char *)
	Tag that make this node a singleton in the scene.

virtual void	SetTypeDisplayName (const std::string &name)

virtual void	SetUndoEnabled (bool)

virtual int	StartModify ()
	Start modifying the node. Disable Modify events.

virtual void	UndoEnabledOff ()

virtual void	UndoEnabledOn ()

virtual void	UpdateReferenceID (const char oldID, const char newID)
	Update the stored reference to another node in the scene.

virtual void	UpdateReferences ()
	The method should remove all pointers and observations to all nodes that are not in the scene anymore.

virtual void	UpdateScene (vtkMRMLScene *)

const char *	URLDecodeString (const char *inString)
	Decode a URL string.

const char *	URLEncodeString (const char *inString)
	Encode a URL string.

virtual void	WriteNodeBodyXML (ostream &of, int indent)
	Write this node's body to a MRML file in XML format.

std::string	XMLAttributeDecodeString (const std::string &inString)
	Decode an XML attribute string.

std::string	XMLAttributeEncodeString (const std::string &inString)
	Encode an XML attribute string (replaces special characters by code sequences)

Static Public Member Functions
static const char *	GetClippingMethodAsString (int type)

static int	GetClippingMethodFromString (const char *name)

static const char *	GetClippingNodeStatePropertyName ()
	Get the node reference property name for the clipping node state.

static const char *	GetClippingStateAsString (int state)

static int	GetClippingStateFromString (const char *name)

static const char *	GetClipTypeAsString (int type)

static int	GetClipTypeFromString (const char *name)

static int	IsTypeOf (const char *type)

static vtkMRMLClipNode *	New ()

static vtkMRMLClipNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLNode
static int	IsTypeOf (const char *type)

static vtkMRMLNode *	SafeDownCast (vtkObject *o)

Protected Member Functions
int	GetSliceClipState (const char *nodeID)

void	OnNodeReferenceAdded (vtkMRMLNodeReference *reference) override
	Called when a node reference ID is added (list size increased).

void	OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
	Called when a node reference ID is modified.

void	OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
	Called after a node reference ID is removed (list size decreased).

void	operator= (const vtkMRMLClipNode &)

void	SetSliceClipState (const char *nodeID, int state)

void	UpdateImplicitFunction ()
	Update the implicit function based on the clipping nodes.

	vtkMRMLClipNode ()

	vtkMRMLClipNode (const vtkMRMLClipNode &)

	~vtkMRMLClipNode () override

Protected Member Functions inherited from vtkMRMLNode
virtual const char *	GetMRMLAttributeNameFromReferenceRole (const char *refRole)
	Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise.

virtual const char *	GetReferenceRoleFromMRMLAttributeName (const char *attName)
	Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise.

virtual char *	GetTempURLString ()

void	GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray oldConsolidatedEventList, vtkIntArray newConsolidatedEventList, vtkMRMLNode oldReferencedNode, vtkMRMLNode newReferencedNode, vtkMRMLNodeReference referenceToIgnore, vtkIntArray newEvents, bool newObserveContentModifiedEvents)

virtual void	InvalidateNodeReferences ()

virtual bool	IsReferenceRoleGeneric (const char *refRole)
	Return true if the reference role is generic (ends with '/') or false otherwise.

std::string	NodeReferencePropertyDecodeString (const std::string &inString)
	Decode a node reference property string.

std::string	NodeReferencePropertyEncodeString (const std::string &inString)
	Encode a node reference property string (replaces special characters by code sequences)

void	operator= (const vtkMRMLNode &)

void	ParseReferencesAttribute (const char *attValue, std::set< std::string > &references)

void	RemoveInvalidReferences (const std::set< std::string > &validNodeIDs)

virtual void	SetTempURLString (const char *)
	Get/Set the string used to manage encoding/decoding of strings/URLs with special characters.

vtkMRMLNode *	UpdateNodeReferenceEventObserver (vtkMRMLNode oldReferencedNode, vtkMRMLNode newReferencedNode, vtkIntArray newEvents, bool newObserveContentModifiedEvents, vtkMRMLNodeReference referenceToIgnore)

virtual void	UpdateNodeReferences (const char *referenceRole=nullptr)

virtual void	UpdateNthNodeReference (const char *referenceRole, int n)

	vtkMRMLNode ()

	vtkMRMLNode (const vtkMRMLNode &)

	~vtkMRMLNode () override
	critical to have a virtual destructor!

Static Protected Member Functions
static bool	GetClippingPlanesFromFunction (vtkImplicitFunction function, vtkPlaneCollection planeCollection, bool invert=false)

Static Protected Member Functions inherited from vtkMRMLNode
static void	MRMLCallback (vtkObject caller, unsigned long eid, void clientData, void *callData)

Protected Attributes
int	ClippingMethod

vtkSmartPointer< vtkImplicitBoolean >	ImplicitFunction

Protected Attributes inherited from vtkMRMLNode
int	AddToScene { 1 }

AttributesType	Attributes

vtkIntArray *	ContentModifiedEvents

std::string	DefaultNodeNamePrefix

char *	Description { nullptr }

int	HideFromEditors { 0 }

char *	ID { nullptr }

int	InMRMLCallbackFlag { 0 }
	Flag to avoid event loops.

vtkCallbackCommand *	MRMLCallbackCommand
	Holders for MRML callbacks.

vtkObserverManager *	MRMLObserverManager

char *	Name { nullptr }

NodeReferenceEventsType	NodeReferenceEvents

std::map< std::string, std::string >	NodeReferenceMRMLAttributeNames

NodeReferencesType	NodeReferences

int	SaveWithScene { true }

vtkWeakPointer< vtkMRMLScene >	Scene

int	Selectable { 1 }

int	Selected { 0 }

std::string	TypeDisplayName

bool	UndoEnabled { false }

Static Protected Attributes
static const char *	ClippingNodeReferenceRef

static const char *	ClippingNodeReferenceRole

static const char *	ClippingNodeStatePropertyName

Additional Inherited Members
Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string >	AttributesType

typedef std::map< std::string, NodeReferenceEventList >	NodeReferenceEventsType

typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > >	NodeReferenceListType

typedef std::map< std::string, NodeReferenceListType >	NodeReferencesType

Detailed Description

MRML node to represent three clipping planes.

The vtkMRMLClipNode MRML node stores references to nodes that represent clipping functions. The clipping function can be from:

Planes with vtkMRMLSliceNode or vtkMRMLMarkupsPlaneNode, vtkMRMLMarkupsROINode
Polydata vtkMRMLModelNode
Implicit functions from other vtkMRMLClipNode
Any other vtkMRMLTransformableNode node types that implement GetImplicitFunctionWorld(). Each clipping node reference can be enabled, disabled, or inverted by setting the clipping state. The clipping functions are combined using a vtkImplicitBoolean operation using either an intersection or union operation.

Definition at line 41 of file vtkMRMLClipNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLNode vtkMRMLClipNode::Superclass

Definition at line 45 of file vtkMRMLClipNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

ClipNodeModifiedEvent is invoked when:

a clipping node is added or removed
a clipping node is modified

Enumerator
ClipNodeModifiedEvent

Definition at line 70 of file vtkMRMLClipNode.h.

◆ ClippingMethodType

enum vtkMRMLClipNode::ClippingMethodType

Indicates what clipping method should be used Straight cut, whole cell extraction, or whole cell extraction with boundary cells

Enumerator
Straight
WholeCells
WholeCellsWithBoundary

Definition at line 152 of file vtkMRMLClipNode.h.

◆ ClippingStateType

enum vtkMRMLClipNode::ClippingStateType

Clipping state for each clipping node reference.

Enumerator
ClipOff
ClipPositiveSpace
ClipNegativeSpace

Definition at line 100 of file vtkMRMLClipNode.h.

◆ ClipTypeType

enum vtkMRMLClipNode::ClipTypeType

Enumerator
ClipIntersection
ClipUnion

Definition at line 75 of file vtkMRMLClipNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLClipNode() [1/2]

vtkMRMLClipNode::vtkMRMLClipNode ( )

protected

◆ ~vtkMRMLClipNode()

vtkMRMLClipNode::~vtkMRMLClipNode ( )

overrideprotected

◆ vtkMRMLClipNode() [2/2]

vtkMRMLClipNode::vtkMRMLClipNode ( const vtkMRMLClipNode & )

protected

Member Function Documentation

◆ AddAndObserveClippingNodeID()

void vtkMRMLClipNode::AddAndObserveClippingNodeID ( const char * clippingNodeID )

Adds a clip plane node ID to the list of clip plane node IDs Clip planes can be vtkMRMLSliceNode or vtkMRMLMarkupsPlaneNode

See also: SetAndObserveClipNodeID(int, const char*)

◆ CopyReferences()

void vtkMRMLClipNode::CopyReferences ( vtkMRMLNode * node )

overridevirtual

Overridden to update the implicit function when the clipping nodes are modified.

Reimplemented from vtkMRMLNode.

◆ CreateNodeInstance()

vtkMRMLNode * vtkMRMLClipNode::CreateNodeInstance ( )

overridevirtual

MRMLNode methods.

Implements vtkMRMLNode.

◆ GetClassName()

virtual const char * vtkMRMLClipNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLClipModelsNode.

◆ GetClippingMethod()

virtual int vtkMRMLClipNode::GetClippingMethod ( )

virtual

Get or set the clipping method. The clipping method determines how the polygons are clipped by the planes.

See also: ClippingMethodType

◆ GetClippingMethodAsString()

static const char * vtkMRMLClipNode::GetClippingMethodAsString ( int type )

static

◆ GetClippingMethodFromString()

static int vtkMRMLClipNode::GetClippingMethodFromString ( const char * name )

static

Get the clipping method from/as a string

See also: ClippingMethodType

◆ GetClippingNode()

vtkMRMLNode * vtkMRMLClipNode::GetClippingNode ( )

◆ GetClippingNodeID()

const char * vtkMRMLClipNode::GetClippingNodeID ( )

◆ GetClippingNodeIndex()

int vtkMRMLClipNode::GetClippingNodeIndex ( const char * nodeID )

Get or set the clipping node index.

◆ GetClippingNodeIndexFromID()

int vtkMRMLClipNode::GetClippingNodeIndexFromID ( const char * clippingNodeID )

Get the index of the clipping node.

◆ GetClippingNodeReferenceRole()

const char * vtkMRMLClipNode::GetClippingNodeReferenceRole ( ) const

Node reference role used for storing clip plane node references.

◆ GetClippingNodeState() [1/2]

int vtkMRMLClipNode::GetClippingNodeState ( const char * nodeID )

◆ GetClippingNodeState() [2/2]

int vtkMRMLClipNode::GetClippingNodeState ( vtkMRMLNode * node )

Get or set the clipping node state.

See also: ClippingStateType

◆ GetClippingNodeStatePropertyName()

static const char * vtkMRMLClipNode::GetClippingNodeStatePropertyName ( )

static

Get the node reference property name for the clipping node state.

◆ GetClippingPlanes()

bool vtkMRMLClipNode::GetClippingPlanes	(	vtkPlaneCollection *	planeCollection,
		bool	invert = false,
		vtkMRMLMessageCollection *	messages = nullptr )

Get the list of all clipping planes in the clip node, including from nested clip nodes. Returns false if not all of the functions in the clip node are planes.

◆ GetClippingPlanesFromFunction()

static bool vtkMRMLClipNode::GetClippingPlanesFromFunction	(	vtkImplicitFunction *	function,
		vtkPlaneCollection *	planeCollection,
		bool	invert = false )

staticprotected

Get the list of all clipping planes in the implicit function. If invert is true, then the plane normals will be flipped. Returns false if not all of the functions in the clip node are planes.

◆ GetClippingStateAsString()

static const char * vtkMRMLClipNode::GetClippingStateAsString ( int state )

static

◆ GetClippingStateFromString()

static int vtkMRMLClipNode::GetClippingStateFromString ( const char * name )

static

Get the clipping state from/as a string

See also: ClippingStateType

◆ GetClipType()

int vtkMRMLClipNode::GetClipType ( )

◆ GetClipTypeAsString()

static const char * vtkMRMLClipNode::GetClipTypeAsString ( int type )

static

◆ GetClipTypeFromString()

static int vtkMRMLClipNode::GetClipTypeFromString ( const char * name )

static

Get the clip type from/as a string.

See also: ClipTypeType

◆ GetGreenSliceClipState()

int vtkMRMLClipNode::GetGreenSliceClipState ( )

Indicates if the Green slice clipping is Off, Positive space, or Negative space

Deprecated: Prefer SetClippingNodeState() and GetClippingNodeState()

◆ GetImplicitFunctionWorld()

vtkImplicitFunction * vtkMRMLClipNode::GetImplicitFunctionWorld ( )

Get the implicit function that represents the clipping function created from the referenced clipping nodes.

◆ GetNodeTagName()

const char * vtkMRMLClipNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 65 of file vtkMRMLClipNode.h.

◆ GetNthClippingNode()

vtkMRMLNode * vtkMRMLClipNode::GetNthClippingNode ( int n )

Get the clipping node.

◆ GetNthClippingNodeID()

const char * vtkMRMLClipNode::GetNthClippingNodeID ( int n )

Get the clip plane node ID.

◆ GetNthClippingNodeState()

int vtkMRMLClipNode::GetNthClippingNodeState ( int n )

◆ GetNumberOfClippingNodes()

int vtkMRMLClipNode::GetNumberOfClippingNodes ( )

Get the number of clip plane nodes.

◆ GetPlanes()

void vtkMRMLClipNode::GetPlanes ( vtkPlaneCollection * planes )

Get all the plane implicit functions from the clipping nodes.

◆ GetRedSliceClipState()

int vtkMRMLClipNode::GetRedSliceClipState ( )

Indicates if the Red slice clipping is Off, Positive space, or Negative space

Deprecated: Prefer SetClippingNodeState() and GetClippingNodeState()

◆ GetSliceClipState()

int vtkMRMLClipNode::GetSliceClipState ( const char * nodeID )

protected

◆ GetYellowSliceClipState()

int vtkMRMLClipNode::GetYellowSliceClipState ( )

Indicates if the Yellow slice clipping is Off, Positive space, or Negative space

Deprecated: Prefer SetClippingNodeState() and GetClippingNodeState()

◆ HasClippingNodeID()

bool vtkMRMLClipNode::HasClippingNodeID ( const char * clippingNodeID )

Check if the clip plane node ID exists.

◆ IsA()

virtual int vtkMRMLClipNode::IsA ( const char * type )

virtual

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLClipModelsNode.

◆ IsTypeOf()

static int vtkMRMLClipNode::IsTypeOf ( const char * type )

static

◆ New()

static vtkMRMLClipNode * vtkMRMLClipNode::New ( )

static

◆ OnNodeReferenceAdded()

void vtkMRMLClipNode::OnNodeReferenceAdded ( vtkMRMLNodeReference * reference )

overrideprotectedvirtual

Called when a node reference ID is added (list size increased).

Reimplemented from vtkMRMLNode.

◆ OnNodeReferenceModified()

void vtkMRMLClipNode::OnNodeReferenceModified ( vtkMRMLNodeReference * reference )

overrideprotectedvirtual

Called when a node reference ID is modified.

Reimplemented from vtkMRMLNode.

◆ OnNodeReferenceRemoved()

void vtkMRMLClipNode::OnNodeReferenceRemoved ( vtkMRMLNodeReference * reference )

overrideprotectedvirtual

Called after a node reference ID is removed (list size decreased).

Reimplemented from vtkMRMLNode.

◆ operator=()

void vtkMRMLClipNode::operator= ( const vtkMRMLClipNode & )

protected

◆ PrintSelf()

void vtkMRMLClipNode::PrintSelf	(	ostream &	os,
		vtkIndent	indent )

override

◆ ProcessMRMLEvents()

void vtkMRMLClipNode::ProcessMRMLEvents	(	vtkObject *	caller,
		unsigned long	event,
		void *	callData )

overridevirtual

Overridden to update the implicit function when the clipping nodes are modified.

Reimplemented from vtkMRMLNode.

◆ ReadXMLAttributes()

void vtkMRMLClipNode::ReadXMLAttributes ( const char ** atts )

overridevirtual

Read node attributes from XML file.

Reimplemented from vtkMRMLNode.

◆ RemoveAllClippingNodeIDs()

void vtkMRMLClipNode::RemoveAllClippingNodeIDs ( )

◆ RemoveClippingNodeID()

void vtkMRMLClipNode::RemoveClippingNodeID ( const char * clippingNodeID )

Remove the clip plane node.

◆ RemoveNthClippingNodeID()

void vtkMRMLClipNode::RemoveNthClippingNodeID ( int n )

◆ SafeDownCast()

static vtkMRMLClipNode * vtkMRMLClipNode::SafeDownCast ( vtkObject * o )

static

◆ SetAndObserveClippingNodeID()

void vtkMRMLClipNode::SetAndObserveClippingNodeID ( const char * clippingNodeID )

Set and observe the clip plane node ID Clip planes can be vtkMRMLSliceNode or vtkMRMLMarkupsPlaneNode

See also: AddAndObserveClipNodeID(const char*)

◆ SetAndObserveNthClippingNodeID()

void vtkMRMLClipNode::SetAndObserveNthClippingNodeID	(	int	n,
		const char *	clippingNodeID )

◆ SetClippingMethod()

virtual void vtkMRMLClipNode::SetClippingMethod ( int )

virtual

◆ SetClippingNodeState() [1/2]

void vtkMRMLClipNode::SetClippingNodeState	(	const char *	nodeID,
		int	)

◆ SetClippingNodeState() [2/2]

void vtkMRMLClipNode::SetClippingNodeState	(	vtkMRMLNode *	,
		int	)

◆ SetClipType()

void vtkMRMLClipNode::SetClipType ( int clipType )

Indicates the type of clipping "Intersection" or "Union"

See also: ClipTypeType

◆ SetGreenSliceClipState()

void vtkMRMLClipNode::SetGreenSliceClipState ( int )

◆ SetNthClippingNodeState()

void vtkMRMLClipNode::SetNthClippingNodeState	(	int	n,
		int	state )

◆ SetRedSliceClipState()

void vtkMRMLClipNode::SetRedSliceClipState ( int )

◆ SetSliceClipState()

void vtkMRMLClipNode::SetSliceClipState	(	const char *	nodeID,
		int	state )

protected

◆ SetYellowSliceClipState()

void vtkMRMLClipNode::SetYellowSliceClipState ( int )

◆ UpdateImplicitFunction()

void vtkMRMLClipNode::UpdateImplicitFunction ( )

protected

Update the implicit function based on the clipping nodes.

◆ vtkMRMLCopyContentMacro()

vtkMRMLClipNode::vtkMRMLCopyContentMacro ( vtkMRMLClipNode )

Copy node content (excludes basic data, such as name and node references).

See also: vtkMRMLNode::CopyContent

◆ WriteXML()

void vtkMRMLClipNode::WriteXML	(	ostream &	of,
		int	indent )

overridevirtual

Write this node's information to a MRML file in XML format.

Reimplemented from vtkMRMLNode.

Member Data Documentation

◆ ClippingMethod

int vtkMRMLClipNode::ClippingMethod

protected

Definition at line 268 of file vtkMRMLClipNode.h.

◆ ClippingNodeReferenceRef

const char* vtkMRMLClipNode::ClippingNodeReferenceRef

staticprotected

Definition at line 265 of file vtkMRMLClipNode.h.

◆ ClippingNodeReferenceRole

const char* vtkMRMLClipNode::ClippingNodeReferenceRole

staticprotected

Definition at line 264 of file vtkMRMLClipNode.h.

◆ ClippingNodeStatePropertyName

const char* vtkMRMLClipNode::ClippingNodeStatePropertyName

staticprotected

Definition at line 266 of file vtkMRMLClipNode.h.

◆ ImplicitFunction

vtkSmartPointer<vtkImplicitBoolean> vtkMRMLClipNode::ImplicitFunction

protected

Definition at line 270 of file vtkMRMLClipNode.h.

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

Libs/MRML/Core/vtkMRMLClipNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ ClippingMethodType

◆ ClippingStateType

◆ ClipTypeType

Constructor & Destructor Documentation

◆ vtkMRMLClipNode() [1/2]

◆ ~vtkMRMLClipNode()

◆ vtkMRMLClipNode() [2/2]

Member Function Documentation

◆ AddAndObserveClippingNodeID()

◆ CopyReferences()

◆ CreateNodeInstance()

◆ GetClassName()

◆ GetClippingMethod()

◆ GetClippingMethodAsString()

◆ GetClippingMethodFromString()

◆ GetClippingNode()

◆ GetClippingNodeID()

◆ GetClippingNodeIndex()

◆ GetClippingNodeIndexFromID()

◆ GetClippingNodeReferenceRole()

◆ GetClippingNodeState() [1/2]

◆ GetClippingNodeState() [2/2]

◆ GetClippingNodeStatePropertyName()

◆ GetClippingPlanes()

◆ GetClippingPlanesFromFunction()

◆ GetClippingStateAsString()

◆ GetClippingStateFromString()

◆ GetClipType()

◆ GetClipTypeAsString()

◆ GetClipTypeFromString()

◆ GetGreenSliceClipState()

◆ GetImplicitFunctionWorld()

◆ GetNodeTagName()

◆ GetNthClippingNode()

◆ GetNthClippingNodeID()

◆ GetNthClippingNodeState()

◆ GetNumberOfClippingNodes()

◆ GetPlanes()

◆ GetRedSliceClipState()

◆ GetSliceClipState()

◆ GetYellowSliceClipState()

◆ HasClippingNodeID()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ OnNodeReferenceAdded()

◆ OnNodeReferenceModified()

◆ OnNodeReferenceRemoved()

◆ operator=()

◆ PrintSelf()

◆ ProcessMRMLEvents()

◆ ReadXMLAttributes()

◆ RemoveAllClippingNodeIDs()

◆ RemoveClippingNodeID()

◆ RemoveNthClippingNodeID()

◆ SafeDownCast()

◆ SetAndObserveClippingNodeID()

◆ SetAndObserveNthClippingNodeID()

◆ SetClippingMethod()

◆ SetClippingNodeState() [1/2]

◆ SetClippingNodeState() [2/2]

◆ SetClipType()

◆ SetGreenSliceClipState()

◆ SetNthClippingNodeState()

◆ SetRedSliceClipState()

◆ SetSliceClipState()

◆ SetYellowSliceClipState()