vtkMRMLVolumePropertyNode Class Reference

vtkMRMLVolumePropertyNode contains the transfer functions (scalar opacity, color and gradient opacity) for the volume rendering. More...

#include <Modules/Loadable/VolumeRendering/MRML/vtkMRMLVolumePropertyNode.h>

Inheritance diagram for vtkMRMLVolumePropertyNode:

Collaboration diagram for vtkMRMLVolumePropertyNode:

Public Types
enum	{ EffectiveRangeModified = 62300 }
typedef vtkMRMLStorableNode	Superclass
Public Types inherited from vtkMRMLStorableNode
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
bool	CalculateEffectiveRange ()
void	CopyParameterSet (vtkMRMLNode *node)
vtkMRMLStorageNode *	CreateDefaultStorageNode () override
	Create default storage node or nullptr if does not have one.
vtkMRMLNode *	CreateNodeInstance () override
	MRMLNode methods.
virtual const char *	GetClassName ()
vtkColorTransferFunction *	GetColor (int component=0)
virtual double *	GetEffectiveRange ()
	Get effective range.
virtual void	GetEffectiveRange (double &, double &)
virtual void	GetEffectiveRange (double[2])
vtkPiecewiseFunction *	GetGradientOpacity (int component=0)
const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model)
vtkPiecewiseFunction *	GetScalarOpacity (int component=0)
virtual vtkVolumeProperty *	GetVolumeProperty ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
	Reimplemented for internal reasons.
void	ReadXMLAttributes (const char **atts) override
	Set node attributes.
void	SetColor (vtkColorTransferFunction *newColorFunction, int component=0)
void	SetEffectiveRange (double min, double max)
	Set effective range.
void	SetEffectiveRange (double range[2])
void	SetGradientOpacity (vtkPiecewiseFunction *newGradientOpacity, int component=0)
void	SetPropertyInVolumeNode (vtkVolume *volume)
void	SetScalarOpacity (vtkPiecewiseFunction *newScalarOpacity, int component=0)
	vtkMRMLCopyContentMacro (vtkMRMLVolumePropertyNode)
void	WriteXML (ostream &of, int indent) override
	Write this node's information to a MRML file in XML format.
Public Member Functions inherited from vtkMRMLStorableNode
void	AddAndObserveStorageNodeID (const char *storageNodeID)
virtual bool	AddDefaultStorageNode (const char *filename=nullptr)
void	Copy (vtkMRMLNode *node) override
	Copy node contents from another node of the same type. Reimplemented to copy default sequence storage node class.
virtual vtkMRMLStorageNode *	CreateDefaultSequenceStorageNode ()
virtual std::string	GetDefaultSequenceStorageNodeClassName ()
virtual std::string	GetDefaultStorageNodeClassName (const char *filename=nullptr)
virtual bool	GetModifiedSinceRead ()
vtkMRMLStorageNode *	GetNthStorageNode (int n)
	Get associated display MRML node.
const char *	GetNthStorageNodeID (int n)
int	GetNumberOfStorageNodes ()
const char *	GetSlicerDataType ()
vtkMRMLStorageNode *	GetStorageNode ()
const char *	GetStorageNodeID ()
virtual vtkTagTable *	GetUserTagTable ()
	Methods for user-specified metadata.
bool	HasStorageNodeID (const char *storageNodeID)
	Return true if storageNodeID is in the storage node ID list.
void	PrintSelf (ostream &os, vtkIndent indent) override
void	SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)
void	SetAndObserveStorageNodeID (const char *storageNodeID)
	String ID of the storage MRML node.
virtual void	SetDefaultSequenceStorageNodeClassName (std::string)
void	SetSlicerDataType (const char *type)
virtual void	StorableModified ()
void	UpdateScene (vtkMRMLScene *scene) override
	Finds the storage node and read the data.
	vtkMRMLCopyContentMacro (vtkMRMLStorableNode)
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	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.
virtual void	CopyReferences (vtkMRMLNode *node)
	Copy the references of the node into this.
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 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 const char *	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	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	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.
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 void	GetColorTransferFunctionFromString (const char *str, vtkColorTransferFunction *result)
static void	GetColorTransferFunctionFromString (const std::string &str, vtkColorTransferFunction *result)
static std::string	GetColorTransferFunctionString (vtkColorTransferFunction *function)
static void	GetPiecewiseFunctionFromString (const char *str, vtkPiecewiseFunction *result)
static void	GetPiecewiseFunctionFromString (const std::string &str, vtkPiecewiseFunction *result)
static std::string	GetPiecewiseFunctionString (vtkPiecewiseFunction *function)
static double	HigherAndUnique (double value, double &previousValue)
static int	IsTypeOf (const char *type)
static vtkMRMLVolumePropertyNode *	New ()
	Create a new vtkMRMLVolumePropertyNode.
static double	NextHigher (double value)
static vtkMRMLVolumePropertyNode *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLStorableNode
static int	IsTypeOf (const char *type)
static vtkMRMLStorableNode *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLNode
static int	IsTypeOf (const char *type)
static vtkMRMLNode *	SafeDownCast (vtkObject *o)

Protected Member Functions
double	GetAmbient ()
double	GetDiffuse ()
std::string	GetGradientOpacityAsString ()
int	GetInterpolationType ()
std::string	GetRGBTransferFunctionAsString ()
std::string	GetScalarOpacityAsString ()
int	GetShade ()
double	GetSpecular ()
double	GetSpecularPower ()
void	SetAmbient (double)
void	SetDiffuse (double)
void	SetGradientOpacityAsString (std::string)
void	SetInterpolationType (int)
void	SetRGBTransferFunctionAsString (std::string)
void	SetScalarOpacityAsString (std::string)
void	SetShade (int)
void	SetSpecular (double)
void	SetSpecularPower (double)
	vtkMRMLVolumePropertyNode ()
	~vtkMRMLVolumePropertyNode () override
Protected Member Functions inherited from vtkMRMLStorableNode
virtual const char *	GetStorageNodeReferenceMRMLAttributeName ()
virtual const char *	GetStorageNodeReferenceRole ()
virtual vtkTimeStamp	GetStoredTime ()
void	operator= (const vtkMRMLStorableNode &)
	vtkMRMLStorableNode ()
	vtkMRMLStorableNode (const vtkMRMLStorableNode &)
	~vtkMRMLStorableNode () 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)
virtual void	OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
virtual void	OnNodeReferenceModified (vtkMRMLNodeReference *reference)
	Called when a referenced node pointer is modified.
virtual void	OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
	Called when a referenced node pointer is removed (set to nullptr).
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 int	DataFromString (const std::string &dataString, double *&data)
static std::string	DataToString (double *data, int size)
static int	NodesFromString (const std::string &dataString, double *&data, int nodeSize)
Static Protected Member Functions inherited from vtkMRMLNode
static void	MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)

Protected Attributes
double	EffectiveRange [2] {0.0,-1.0}
bool	IgnoreVolumePropertyChanges {false}
vtkSmartPointer< vtkIntArray >	ObservedEvents
	Events observed on the transfer functions.
vtkVolumeProperty *	VolumeProperty {nullptr}
	Main parameters for visualization.
Protected Attributes inherited from vtkMRMLStorableNode
std::string	DefaultSequenceStorageNodeClassName
std::string	SlicerDataType
vtkTimeStamp	StorableModifiedTime
vtkTagTable *	UserTagTable
Protected Attributes inherited from vtkMRMLNode
int	AddToScene {1}
AttributesType	Attributes
vtkIntArray *	ContentModifiedEvents
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}
bool	UndoEnabled {false}

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
Static Protected Attributes inherited from vtkMRMLStorableNode
static const char *	StorageNodeReferenceMRMLAttributeName
static const char *	StorageNodeReferenceRole

Detailed Description

vtkMRMLVolumePropertyNode contains the transfer functions (scalar opacity, color and gradient opacity) for the volume rendering.

Definition at line 28 of file vtkMRMLVolumePropertyNode.h.

Member Typedef Documentation

Superclass

typedef vtkMRMLStorableNode vtkMRMLVolumePropertyNode::Superclass

Definition at line 40 of file vtkMRMLVolumePropertyNode.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
EffectiveRangeModified	Invoked when. See also EffectiveRange is modified

Definition at line 32 of file vtkMRMLVolumePropertyNode.h.

Constructor & Destructor Documentation

vtkMRMLVolumePropertyNode()

vtkMRMLVolumePropertyNode::vtkMRMLVolumePropertyNode ( )

protected

~vtkMRMLVolumePropertyNode()

vtkMRMLVolumePropertyNode::~vtkMRMLVolumePropertyNode ( )

overrideprotected

Member Function Documentation

CalculateEffectiveRange()

bool vtkMRMLVolumePropertyNode::CalculateEffectiveRange

(

)

Calculate effective range to include all the transfer functions.

Returns

True if calculation was successful, false is not (missing transfer functions)

CopyParameterSet()

void vtkMRMLVolumePropertyNode::CopyParameterSet

(

vtkMRMLNode *

node

)

Copy only the parameter set (like volume properties, piecewise functions etc. as deep copy, but no references etc.)

CreateDefaultStorageNode()

vtkMRMLStorageNode * vtkMRMLVolumePropertyNode::CreateDefaultStorageNode ( )

overridevirtual

Create default storage node or nullptr if does not have one.

Reimplemented from vtkMRMLStorableNode.

CreateNodeInstance()

vtkMRMLNode * vtkMRMLVolumePropertyNode::CreateNodeInstance ( )

overridevirtual

MRMLNode methods.

Implements vtkMRMLStorableNode.

DataFromString()

static int vtkMRMLVolumePropertyNode::DataFromString ( const std::string & dataString, double *& data )

staticprotected

DataToString()

static std::string vtkMRMLVolumePropertyNode::DataToString ( double * data, int size )

staticprotected

GetAmbient()

double vtkMRMLVolumePropertyNode::GetAmbient ( )

protected

GetClassName()

virtual const char * vtkMRMLVolumePropertyNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLStorableNode.

GetColor()

vtkColorTransferFunction * vtkMRMLVolumePropertyNode::GetColor

(

int

component = 0

)

Return the color transfer function for a given component or 0 if no function exists.

See also

SetColor()

GetColorTransferFunctionFromString() [1/2]

void vtkMRMLVolumePropertyNode::GetColorTransferFunctionFromString ( const char * str, vtkColorTransferFunction * result )

inlinestatic

Utility function: Put parameters described in a string into an existing vtkColorTransferFunction. To be used with GetColorTransferFunctionString()

See also

GetColorTransferFunctionFromString()

Definition at line 237 of file vtkMRMLVolumePropertyNode.h.

GetColorTransferFunctionFromString() [2/2]

static void vtkMRMLVolumePropertyNode::GetColorTransferFunctionFromString ( const std::string & str, vtkColorTransferFunction * result )

static

Utility function: Put parameters described in a string into an existing vtkColorTransferFunction, use together with getColorTransferFunctionString

See also

GetColorTransferFunctionString(), GetPiecewiseFunctionFromString()

GetColorTransferFunctionString()

static std::string vtkMRMLVolumePropertyNode::GetColorTransferFunctionString ( vtkColorTransferFunction * function )

static

Utility function that transforms a color transfer function into a string. Format:

/// <numberOfPoints> <XValue1> <RValue1> <GValue1><BValue1> ... <XValueN> <RValueN> <GValueN><BValueN>
/// 

See also

GetColorTransferFunctionFromString(), GetPiecewiseFunctionString()

GetDiffuse()

double vtkMRMLVolumePropertyNode::GetDiffuse ( )

protected

GetEffectiveRange() [1/3]

virtual double * vtkMRMLVolumePropertyNode::GetEffectiveRange ( )

virtual

Get effective range.

GetEffectiveRange() [2/3]

virtual void vtkMRMLVolumePropertyNode::GetEffectiveRange ( double & , double &  )

virtual

GetEffectiveRange() [3/3]

virtual void vtkMRMLVolumePropertyNode::GetEffectiveRange ( double [2] )

virtual

GetGradientOpacity()

vtkPiecewiseFunction * vtkMRMLVolumePropertyNode::GetGradientOpacity

(

int

component = 0

)

Return the gradient opacity function for a given component or 0 if no function exists.

See also

SetGradientOpacity()

GetGradientOpacityAsString()

std::string vtkMRMLVolumePropertyNode::GetGradientOpacityAsString ( )

protected

GetInterpolationType()

int vtkMRMLVolumePropertyNode::GetInterpolationType ( )

protected

GetNodeTagName()

const char * vtkMRMLVolumePropertyNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLStorableNode.

Definition at line 159 of file vtkMRMLVolumePropertyNode.h.

GetPiecewiseFunctionFromString() [1/2]

void vtkMRMLVolumePropertyNode::GetPiecewiseFunctionFromString ( const char * str, vtkPiecewiseFunction * result )

inlinestatic

Utility function: Put parameters described in a string into an existing vtkPiecewiseFunction. To be used with GetPiecewiseFunctionString()

See also

GetPiecewiseFunctionString(), GetPiecewiseFunctionFromString()

Definition at line 228 of file vtkMRMLVolumePropertyNode.h.

GetPiecewiseFunctionFromString() [2/2]

static void vtkMRMLVolumePropertyNode::GetPiecewiseFunctionFromString ( const std::string & str, vtkPiecewiseFunction * result )

static

Utility function: Put parameters described in a string into an existing vtkPiecewiseFunction, use together with GetPiecewiseFunctionString

See also

GetPiecewiseFunctionString(), GetColorTransferFunctionFromString()

GetPiecewiseFunctionString()

static std::string vtkMRMLVolumePropertyNode::GetPiecewiseFunctionString ( vtkPiecewiseFunction * function )

static

Utility function that transforms a piecewise function into a string. Format:

/// <numberOfPoints> <XValue1> <OpacityValue1> ... <XValueN> <OpacityValueN>
/// 

See also

GetPiecewiseFunctionFromString(), GetColorTransferFunctionString()

GetRGBTransferFunctionAsString()

std::string vtkMRMLVolumePropertyNode::GetRGBTransferFunctionAsString ( )

protected

GetScalarOpacity()

vtkPiecewiseFunction * vtkMRMLVolumePropertyNode::GetScalarOpacity

(

int

component = 0

)

Return the scalar opacity function for a given component or 0 if no function exists.

See also

SetScalarOpacity()

GetScalarOpacityAsString()

std::string vtkMRMLVolumePropertyNode::GetScalarOpacityAsString ( )

protected

GetShade()

int vtkMRMLVolumePropertyNode::GetShade ( )

protected

GetSpecular()

double vtkMRMLVolumePropertyNode::GetSpecular ( )

protected

GetSpecularPower()

double vtkMRMLVolumePropertyNode::GetSpecularPower ( )

protected

GetVolumeProperty()

virtual vtkVolumeProperty * vtkMRMLVolumePropertyNode::GetVolumeProperty ( )

virtual

Don't change its scalarOpacity, gradientOpacity or color on the volume property but use the methods below. It wouldn't observe them.

HigherAndUnique()

static double vtkMRMLVolumePropertyNode::HigherAndUnique ( double value, double & previousValue )

static

Utility function: Return the value or the nearest higher value if the value is equal to previousValue. Update previousValue with the new higher value.

See also

NextHigher()

IsA()

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

virtual

Reimplemented from vtkMRMLStorableNode.

IsTypeOf()

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

static

New()

static vtkMRMLVolumePropertyNode * vtkMRMLVolumePropertyNode::New ( )

static

Create a new vtkMRMLVolumePropertyNode.

NextHigher()

static double vtkMRMLVolumePropertyNode::NextHigher ( double value )

static

Utility function: Return the nearest higher value.

See also

HigherAndUnique()

NodesFromString()

static int vtkMRMLVolumePropertyNode::NodesFromString ( const std::string & dataString, double *& data, int nodeSize )

staticprotected

PrintSelf()

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

override

ProcessMRMLEvents()

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

overridevirtual

Reimplemented for internal reasons.

Reimplemented from vtkMRMLStorableNode.

ReadXMLAttributes()

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

overridevirtual

Set node attributes.

Reimplemented from vtkMRMLStorableNode.

SafeDownCast()

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

static

SetAmbient()

void vtkMRMLVolumePropertyNode::SetAmbient ( double )

protected

SetColor()

void vtkMRMLVolumePropertyNode::SetColor	(	vtkColorTransferFunction *	newColorFunction,
		int	component = 0 )

Set the color function to the volume property.

See also

GetColor(), GetPiecewiseFunctionString(), SetScalarOpacity(), SetGradientOpacity()

SetDiffuse()

void vtkMRMLVolumePropertyNode::SetDiffuse ( double )

protected

SetEffectiveRange() [1/2]

void vtkMRMLVolumePropertyNode::SetEffectiveRange	(	double	min,
		double	max )

Set effective range.

SetEffectiveRange() [2/2]

void vtkMRMLVolumePropertyNode::SetEffectiveRange

(

double

range[2]

)

SetGradientOpacity()

void vtkMRMLVolumePropertyNode::SetGradientOpacity	(	vtkPiecewiseFunction *	newGradientOpacity,
		int	component = 0 )

Set the gradient opacity to the volume property.

See also

GetGradientOpacity(), GetPiecewiseFunctionString(), SetScalarOpacity(), SetColor()

SetGradientOpacityAsString()

void vtkMRMLVolumePropertyNode::SetGradientOpacityAsString ( std::string )

protected

SetInterpolationType()

void vtkMRMLVolumePropertyNode::SetInterpolationType ( int )

protected

SetPropertyInVolumeNode()

void vtkMRMLVolumePropertyNode::SetPropertyInVolumeNode

(

vtkVolume *

volume

)

Use this method to set the volume property into a vtkVolume. Using vtkVolume::SetProperty(vtkVolumeProperty*) directly would call Modified() on the volume property (due to a VTK bug), which would make this node "modified since read". Therefore, the .vp file would be also suggested to be saved (even though it is not actually modified). This method sets the property in the volume with suppressing the effect of the superfluous modification events.

SetRGBTransferFunctionAsString()

void vtkMRMLVolumePropertyNode::SetRGBTransferFunctionAsString ( std::string )

protected

SetScalarOpacity()

void vtkMRMLVolumePropertyNode::SetScalarOpacity	(	vtkPiecewiseFunction *	newScalarOpacity,
		int	component = 0 )

Set the scalar opacity to the volume property.

See also

GetScalarOpacity, GetPiecewiseFunctionString(), SetGradientOpacity(), SetColor()

SetScalarOpacityAsString()

void vtkMRMLVolumePropertyNode::SetScalarOpacityAsString ( std::string )

protected

SetShade()

void vtkMRMLVolumePropertyNode::SetShade ( int )

protected

SetSpecular()

void vtkMRMLVolumePropertyNode::SetSpecular ( double )

protected

SetSpecularPower()

void vtkMRMLVolumePropertyNode::SetSpecularPower ( double )

protected

vtkMRMLCopyContentMacro()

vtkMRMLVolumePropertyNode::vtkMRMLCopyContentMacro

(

vtkMRMLVolumePropertyNode

)

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

See also

vtkMRMLNode::CopyContent

WriteXML()

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

overridevirtual

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

Reimplemented from vtkMRMLStorableNode.

Member Data Documentation

EffectiveRange

double vtkMRMLVolumePropertyNode::EffectiveRange[2] {0.0,-1.0}

protected

Effective range of the transfer functions. Outside this range the functions are constant. Elements: {xMin, xMax}. Other axes not supported because the three transfer functions are independent value-wise, and they do not have third and fourth axes.

Definition at line 218 of file vtkMRMLVolumePropertyNode.h.

IgnoreVolumePropertyChanges

bool vtkMRMLVolumePropertyNode::IgnoreVolumePropertyChanges {false}

protected

This flag is used for temporarily ignoring volume property changes. This is needed because vtkVolume invokes Modification events on the volume property when the property is set into the volume.

Definition at line 210 of file vtkMRMLVolumePropertyNode.h.

ObservedEvents

vtkSmartPointer<vtkIntArray> vtkMRMLVolumePropertyNode::ObservedEvents

protected

Events observed on the transfer functions.

Definition at line 205 of file vtkMRMLVolumePropertyNode.h.

VolumeProperty

vtkVolumeProperty* vtkMRMLVolumePropertyNode::VolumeProperty {nullptr}

protected

Main parameters for visualization.

Definition at line 213 of file vtkMRMLVolumePropertyNode.h.

---

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

• Modules/Loadable/VolumeRendering/MRML/vtkMRMLVolumePropertyNode.h