Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
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:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLVolumePropertyNode:
Collaboration graph
[legend]

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
}
 
typedef vtkObject Superclass
 

Public Member Functions

bool CalculateEffectiveRange ()
 
void Copy (vtkMRMLNode *node) override
 Copy the node's attributes to this object. More...
 
void CopyParameterSet (vtkMRMLNode *node)
 
vtkMRMLStorageNodeCreateDefaultStorageNode () override
 Create default storage node or nullptr if does not have one. More...
 
vtkMRMLNodeCreateNodeInstance () override
 MRMLNode methods. More...
 
virtual const char * GetClassName ()
 
vtkColorTransferFunction * GetColor (int component=0)
 
virtual double * GetEffectiveRange ()
 Get effective range. More...
 
virtual void GetEffectiveRange (double &, double &)
 
virtual void GetEffectiveRange (double [2])
 
vtkPiecewiseFunction * GetGradientOpacity (int component=0)
 
bool GetModifiedSinceRead () override
 
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Model) More...
 
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. More...
 
void ReadXMLAttributes (const char **atts) override
 Set node attributes. More...
 
void SetColor (vtkColorTransferFunction *newColorFunction, int component=0)
 
void SetEffectiveRange (double min, double max)
 Set effective range. More...
 
void SetEffectiveRange (double range[2])
 
void SetGradientOpacity (vtkPiecewiseFunction *newGradientOpacity, int component=0)
 
void SetScalarOpacity (vtkPiecewiseFunction *newScalarOpacity, int component=0)
 
void WriteXML (ostream &of, int indent) override
 Write this node's information to a MRML file in XML format. More...
 
- Public Member Functions inherited from vtkMRMLStorableNode
void AddAndObserveStorageNodeID (const char *storageNodeID)
 
virtual bool AddDefaultStorageNode (const char *filename=nullptr)
 
virtual std::string GetDefaultStorageNodeClassName (const char *filename=nullptr)
 
vtkMRMLStorageNodeGetNthStorageNode (int n)
 
Get associated display MRML node More...
 
const char * GetNthStorageNodeID (int n)
 
int GetNumberOfStorageNodes ()
 
const char * GetSlicerDataType ()
 
vtkMRMLStorageNodeGetStorageNode ()
 
const char * GetStorageNodeID ()
 
virtual vtkTagTableGetUserTagTable ()
 Methods for user-specified metadata. More...
 
bool HasStorageNodeID (const char *storageNodeID)
 
Return true if storageNodeID is in the storage node ID list. More...
 
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 More...
 
void SetSlicerDataType (const char *type)
 
virtual void StorableModified ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data More...
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list. More...
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
 Add a referenceRole. More...
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithoutModifiedEvent (vtkMRMLNode *node)
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSingleModifiedEvent (vtkMRMLNode *node)
 
void DisableModifiedEventOff ()
 
void DisableModifiedEventOn ()
 
virtual int EndModify (int previousDisableModifiedEventState)
 End modifying the node. More...
 
virtual int GetAddToScene ()
 node added to MRML scene. More...
 
const char * GetAttribute (const char *name)
 Get value of a name value pair attribute. More...
 
std::vector< std::string > GetAttributeNames ()
 Get all attribute names. More...
 
void GetAttributeNames (vtkStringArray *attributeNames)
 Get all attribute names. Python-wrappable version. More...
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros. More...
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden. More...
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML. More...
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops. More...
 
virtual int GetModifiedEventPending ()
 
virtual char * GetName ()
 
vtkMRMLNodeGetNodeReference (const char *referenceRole)
 
const char * GetNodeReferenceID (const char *referenceRole)
 Utility function that returns the first node id for a specific referenceRole. More...
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
 Return a list of the referenced node IDs. More...
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
 Return a list of the referenced nodes. More...
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
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). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual bool GetUndoEnabled ()
 
bool HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Return true if referencedNodeID is in the node ID list for a specific referenceRole. More...
 
virtual void HideFromEditorsOff ()
 
virtual void HideFromEditorsOn ()
 
virtual void InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
 This method allows the node to compress events. More...
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending. More...
 
bool IsSingleton ()
 
void Modified () override
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...
 
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. More...
 
void RemoveAttribute (const char *name)
 Remove attribute with the specified name. More...
 
void RemoveNodeReferenceIDs (const char *referenceRole)
 Remove all node IDs and associated nodes for a specific referenceRole. More...
 
void RemoveNthNodeReferenceID (const char *referenceRole, int n)
 Convenience method that removes the Nth node ID from the list. More...
 
virtual void Reset (vtkMRMLNode *defaultNode)
 Reset node attributes to the initial state as defined in the constructor or the passed default node. More...
 
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)
 
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe the Nth node ID for a specific reference role. More...
 
void SetAttribute (const char *name, const char *value)
 Set a name value pair attribute. More...
 
virtual void SetDescription (const char *)
 Text description of this node, to be set by the user. More...
 
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. More...
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
 Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More...
 
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. More...
 
virtual void SetSceneReferences ()
 Update the references of the node to the scene. More...
 
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. More...
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
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. More...
 
virtual void UpdateReferences ()
 The method should remove all pointers and observations to all nodes that are not in the scene anymore. More...
 
const char * URLDecodeString (const char *inString)
 Decode a URL string. More...
 
const char * URLEncodeString (const char *inString)
 Encode a URL string. More...
 
virtual void WriteNodeBodyXML (ostream &of, int indent)
 Write this node's body to a MRML file in XML format. More...
 
std::string XMLAttributeDecodeString (const std::string &inString)
 Decode an XML attribute string. More...
 
std::string XMLAttributeEncodeString (const std::string &inString)
 Encode an XML attribute string (replaces special characters by code sequences) More...
 

Static Public Member Functions

static void GetColorTransferFunctionFromString (const std::string &str, vtkColorTransferFunction *result)
 
static void GetColorTransferFunctionFromString (const char *str, vtkColorTransferFunction *result)
 
static std::string GetColorTransferFunctionString (vtkColorTransferFunction *function)
 
static void GetPiecewiseFunctionFromString (const std::string &str, vtkPiecewiseFunction *result)
 
static void GetPiecewiseFunctionFromString (const char *str, vtkPiecewiseFunction *result)
 
static std::string GetPiecewiseFunctionString (vtkPiecewiseFunction *function)
 
static double HigherAndUnique (double value, double &previousValue)
 
static int IsTypeOf (const char *type)
 
static vtkMRMLVolumePropertyNodeNew ()
 Create a new vtkMRMLVolumePropertyNode. More...
 
static double NextHigher (double value)
 
static vtkMRMLVolumePropertyNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLStorableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLStorableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (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 (void)
 
 ~vtkMRMLVolumePropertyNode (void) 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. More...
 
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. More...
 
virtual char * GetTempURLString ()
 
void GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents)
 
virtual void InvalidateNodeReferences ()
 
virtual bool IsReferenceRoleGeneric (const char *refRole)
 Return true if the reference role is generic (ends with '/') or false otherwise. More...
 
virtual void OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
 
virtual void OnNodeReferenceModified (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is modified. More...
 
virtual void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is removed (set to nullptr). More...
 
void operator= (const vtkMRMLNode &)
 
void ParseReferencesAttribute (const char *attValue, std::map< std::string, std::string > &references)
 
virtual void SetTempURLString (const char *)
 Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, 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! More...
 

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

int DisabledModify
 Keep track of state of disable modified events. More...
 
double EffectiveRange [2]
 
vtkIntArray * ObservedEvents
 Events observed on the transfer functions. More...
 
vtkVolumeProperty * VolumeProperty
 Main parameters for visualization. More...
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene
 
AttributesType Attributes
 
char * Description
 
int HideFromEditors
 
char * ID
 
int InMRMLCallbackFlag
 
Flag to avoid event loops More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable
 
int Selected
 
bool UndoEnabled
 

Additional Inherited Members

- Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string > AttributesType
 
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > > NodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 
- 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 27 of file vtkMRMLVolumePropertyNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkMRMLVolumePropertyNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
EffectiveRangeModified 

Invoked when.

See also
EffectiveRange is modified

Definition at line 31 of file vtkMRMLVolumePropertyNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLVolumePropertyNode()

vtkMRMLVolumePropertyNode::vtkMRMLVolumePropertyNode ( void  )
protected

◆ ~vtkMRMLVolumePropertyNode()

vtkMRMLVolumePropertyNode::~vtkMRMLVolumePropertyNode ( void  )
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)

◆ Copy()

void vtkMRMLVolumePropertyNode::Copy ( vtkMRMLNode node)
overridevirtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLStorableNode.

◆ 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]

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

◆ GetColorTransferFunctionFromString() [2/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 230 of file vtkMRMLVolumePropertyNode.h.

◆ 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 void vtkMRMLVolumePropertyNode::GetEffectiveRange ( double &  ,
double &   
)
virtual

◆ GetEffectiveRange() [2/3]

virtual double* vtkMRMLVolumePropertyNode::GetEffectiveRange ( )
virtual

Get effective range.

◆ 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

◆ GetModifiedSinceRead()

bool vtkMRMLVolumePropertyNode::GetModifiedSinceRead ( )
overridevirtual

◆ GetNodeTagName()

const char* vtkMRMLVolumePropertyNode::GetNodeTagName ( )
inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLStorableNode.

Definition at line 157 of file vtkMRMLVolumePropertyNode.h.

◆ GetPiecewiseFunctionFromString() [1/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()

◆ GetPiecewiseFunctionFromString() [2/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 221 of file vtkMRMLVolumePropertyNode.h.

◆ 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

◆ 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

◆ 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

◆ 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

◆ DisabledModify

int vtkMRMLVolumePropertyNode::DisabledModify
protected

Keep track of state of disable modified events.

Definition at line 210 of file vtkMRMLVolumePropertyNode.h.

◆ EffectiveRange

double vtkMRMLVolumePropertyNode::EffectiveRange[2]
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 funcsions are independent value-wise, and they do not have third and fourth axes.

Definition at line 207 of file vtkMRMLVolumePropertyNode.h.

◆ ObservedEvents

vtkIntArray* vtkMRMLVolumePropertyNode::ObservedEvents
protected

Events observed on the transfer functions.

Definition at line 199 of file vtkMRMLVolumePropertyNode.h.

◆ VolumeProperty

vtkVolumeProperty* vtkMRMLVolumePropertyNode::VolumeProperty
protected

Main parameters for visualization.

Definition at line 202 of file vtkMRMLVolumePropertyNode.h.


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