Slicer  4.13
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 | Protected Attributes
vtkMRMLSequenceBrowserNode Class Reference

#include <Modules/Loadable/Sequences/MRML/vtkMRMLSequenceBrowserNode.h>

Inheritance diagram for vtkMRMLSequenceBrowserNode:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLSequenceBrowserNode:
Collaboration graph
[legend]

Public Types

enum  { ProxyNodeModifiedEvent = 21001, IndexDisplayFormatModifiedEvent }
 ProxyNodeModifiedEvent is invoked when a proxy node is modified. More...
 
enum  IndexDisplayModeType { IndexDisplayAsIndex = 0, IndexDisplayAsIndexValue, NumberOfIndexDisplayModes }
 Modes displaying index for the user. More...
 
enum  RecordingSamplingModeType { SamplingAll = 0, SamplingLimitedToPlaybackFrameRate, NumberOfRecordingSamplingModes }
 Modes for determining recording frame rate. More...
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

vtkMRMLNodeAddProxyNode (vtkMRMLNode *sourceProxyNode, vtkMRMLSequenceNode *sequenceNode, bool copy=true)
 Adds proxy nodes from another scene (typically from the main scene). The data node is optionally copied. More...
 
std::string AddSynchronizedSequenceNode (const char *synchronizedSequenceNodeId)
 Deprecated. Use AddSynchronizedSequenceNodeID instead. More...
 
std::string AddSynchronizedSequenceNode (vtkMRMLSequenceNode *synchronizedSequenceNode)
 Adds a node for synchronized browsing. Returns the new proxy node postfix. More...
 
std::string AddSynchronizedSequenceNodeID (const char *synchronizedSequenceNodeId)
 Adds a node for synchronized browsing. Returns the new proxy node postfix. More...
 
void Copy (vtkMRMLNode *node) override
 Copy the node's attributes to this object. More...
 
vtkMRMLNodeCreateNodeInstance () override
 Create instance of a GAD node. More...
 
void GetAllProxyNodes (std::vector< vtkMRMLNode * > &nodes)
 
void GetAllProxyNodes (vtkCollection *nodes)
 
void GetAllVirtualOutputDataNodes (vtkCollection *nodes)
 Deprecated method! More...
 
virtual const char * GetClassName ()
 
std::string GetFormattedIndexValue (int index)
 
virtual std::string GetIndexDisplayFormat ()
 Get format of index value display. More...
 
virtual int GetIndexDisplayMode ()
 Get index display mode. More...
 
virtual std::string GetIndexDisplayModeAsString ()
 
vtkMRMLSequenceNodeGetMasterSequenceNode ()
 Get the sequence data node. More...
 
const char * GetNodeTagName () override
 Get unique node XML tag name (like Volume, Model) More...
 
int GetNumberOfItems ()
 Returns number of items in the sequence (number of data nodes in master sequence node) More...
 
int GetNumberOfSynchronizedSequenceNodes (bool includeMasterNode=false)
 Returns number of synchronized sequence nodes. More...
 
bool GetOverwriteProxyName (vtkMRMLSequenceNode *sequenceNode)
 Overwrite proxy node name with name automatically generated from sequence base name and current item index. More...
 
bool GetPlayback (vtkMRMLSequenceNode *sequenceNode)
 
virtual bool GetPlaybackActive ()
 Get/Set automatic playback (automatic continuous changing of selected sequence nodes) More...
 
virtual bool GetPlaybackItemSkippingEnabled ()
 Skipping items if necessary to reach requested playback rate. Enabled by default. More...
 
virtual bool GetPlaybackLooped ()
 Get/Set playback looping (restart from the first sequence node when reached the last one) More...
 
virtual double GetPlaybackRateFps ()
 Get/Set playback rate in fps (frames per second) More...
 
vtkMRMLNodeGetProxyNode (vtkMRMLSequenceNode *sequenceNode)
 Get proxy corresponding to a sequence node. More...
 
bool GetRecording (vtkMRMLSequenceNode *sequenceNode)
 Get the synchronization properties for the given sequence/proxy tuple. More...
 
virtual bool GetRecordingActive ()
 Get/set recording of proxy nodes. More...
 
virtual int GetRecordingSamplingMode ()
 Get the recording sampling mode. More...
 
virtual std::string GetRecordingSamplingModeAsString ()
 
virtual bool GetRecordMasterOnly ()
 Get/set whether to only record when the master node is modified (or emits an observed event) More...
 
bool GetSaveChanges (vtkMRMLSequenceNode *sequenceNode)
 
virtual int GetSelectedItemNumber ()
 Get/Set selected bundle index. More...
 
vtkMRMLSequenceNodeGetSequenceNode (vtkMRMLNode *proxyNode)
 Get sequence node corresponding to a proxy node. More...
 
void GetSynchronizedSequenceNodes (std::vector< vtkMRMLSequenceNode * > &synchronizedDataNodes, bool includeMasterNode=false)
 Returns all synchronized sequence nodes (does not include the master sequence node) More...
 
void GetSynchronizedSequenceNodes (vtkCollection *synchronizedDataNodes, bool includeMasterNode=false)
 
vtkMRMLNodeGetVirtualOutputDataNode (vtkMRMLSequenceNode *sequenceNode)
 Deprecated method! More...
 
virtual int IsA (const char *type)
 
bool IsAnySequenceNodeRecording ()
 Returns true if any of the sequence node is allowed to record. More...
 
bool IsProxyNode (const char *nodeId)
 Deprecated. Use IsProxyNodeID instead. More...
 
bool IsProxyNodeID (const char *nodeId)
 Returns true if the nodeId belongs to a proxy node managed by this browser node. More...
 
bool IsSynchronizedSequenceNode (const char *sequenceNodeId, bool includeMasterNode=false)
 Deprecated. Use IsSynchronizedSequenceNodeID instead. More...
 
bool IsSynchronizedSequenceNode (vtkMRMLSequenceNode *sequenceNode, bool includeMasterNode=false)
 
bool IsSynchronizedSequenceNodeID (const char *sequenceNodeId, bool includeMasterNode=false)
 Returns true if the node is selected for synchronized browsing. More...
 
virtual void PlaybackActiveOff ()
 
virtual void PlaybackActiveOn ()
 
virtual void PlaybackItemSkippingEnabledOff ()
 
virtual void PlaybackItemSkippingEnabledOn ()
 
virtual void PlaybackLoopedOff ()
 
virtual void PlaybackLoopedOn ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
 Process MRML node events for recording of the proxy nodes. More...
 
void ReadXMLAttributes (const char **atts) override
 Set node attributes from name/value pairs. More...
 
virtual void RecordingActiveOff ()
 
virtual void RecordingActiveOn ()
 
virtual void RecordMasterOnlyOff ()
 
virtual void RecordMasterOnlyOn ()
 
void RemoveAllProxyNodes ()
 
void RemoveAllSequenceNodes ()
 Remove all sequence nodes (including the master sequence node) More...
 
void RemoveProxyNode (const std::string &postfix)
 
void RemoveSynchronizedSequenceNode (const char *nodeId)
 Removes a node from synchronized browsing. More...
 
virtual void SaveProxyNodesState ()
 Save state of all proxy nodes that recording is enabled for. More...
 
int SelectFirstItem ()
 Selects first sequence item for display, returns current selected item number. More...
 
int SelectLastItem ()
 Selects last sequence item for display, returns current selected item number. More...
 
int SelectNextItem (int selectionIncrement=1)
 Selects the next sequence item for display, returns current selected item number. More...
 
std::string SetAndObserveMasterSequenceNodeID (const char *sequenceNodeID)
 
void SetDeepCopyVirtualNodes (bool deepcopy)
 Deprecated method! More...
 
void SetIndexDisplayFormat (std::string displayFormat)
 Set format of index value display. More...
 
virtual void SetIndexDisplayMode (int)
 Set index display mode. More...
 
void SetIndexDisplayModeFromString (const char *indexDisplayModeString)
 
void SetOverwriteProxyName (vtkMRMLSequenceNode *sequenceNode, bool overwrite)
 
void SetOverwriteTargetNodeName (bool overwrite)
 Deprecated method! More...
 
void SetPlayback (vtkMRMLSequenceNode *sequenceNode, bool playback)
 
virtual void SetPlaybackActive (bool)
 
virtual void SetPlaybackItemSkippingEnabled (bool)
 
virtual void SetPlaybackLooped (bool)
 
virtual void SetPlaybackRateFps (double)
 
void SetRecording (vtkMRMLSequenceNode *sequenceNode, bool recording)
 Set the synchrnization properties for the given sequence/proxy tuple. More...
 
void SetRecordingActive (bool recording)
 
virtual void SetRecordingSamplingMode (int)
 Set the recording sampling mode. More...
 
void SetRecordingSamplingModeFromString (const char *recordingSamplingModeString)
 
virtual void SetRecordMasterOnly (bool)
 
void SetSaveChanges (vtkMRMLSequenceNode *sequenceNode, bool save)
 
virtual void SetSelectedItemNumber (int)
 
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 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 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. More...
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
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 vtkIntArray * GetContentModifiedEvents ()
 
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 ()
 
virtual bool HasCopyContent () const
 Returns true if the class supports deep and shallow copying node content. More...
 
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...
 
virtual void UpdateScene (vtkMRMLScene *)
 
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 std::string GetIndexDisplayModeAsString (int indexDisplayMode)
 Helper functions for converting between string and code representation of index display modes. More...
 
static int GetIndexDisplayModeFromString (const std::string &indexDisplayModeString)
 
static std::string GetRecordingSamplingModeAsString (int recordingSamplingMode)
 Helper functions for converting between string and code representation of recording sampling modes. More...
 
static int GetRecordingSamplingModeFromString (const std::string &recordingSamplingModeString)
 
static int IsTypeOf (const char *type)
 
static vtkMRMLSequenceBrowserNodeNew ()
 
static vtkMRMLSequenceBrowserNodeSafeDownCast (vtkObject *o)
 
static bool ValidateFormatString (std::string &validatedFormat, std::string &prefix, std::string &suffix, const std::string &requestedFormat, const std::string &typeString)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

void FixSequenceNodeReferenceRoleName ()
 
std::string GenerateSynchronizationPostfix ()
 
std::string GetSynchronizationPostfixFromSequence (vtkMRMLSequenceNode *sequenceNode)
 
std::string GetSynchronizationPostfixFromSequenceID (const char *sequenceNodeID)
 
void OnNodeReferenceAdded (vtkMRMLNodeReference *nodeReference) override
 Called whenever a new node reference is added. More...
 
void operator= (const vtkMRMLSequenceBrowserNode &)
 
 vtkMRMLSequenceBrowserNode ()
 
 vtkMRMLSequenceBrowserNode (const vtkMRMLSequenceBrowserNode &)
 
 ~vtkMRMLSequenceBrowserNode () 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 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::set< 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...
 

Protected Attributes

std::string IndexDisplayFormat
 
int IndexDisplayMode {vtkMRMLSequenceBrowserNode::IndexDisplayAsIndexValue}
 
int LastPostfixIndex {0}
 
double LastSaveProxyNodesStateTimeSec
 
bool PlaybackActive {false}
 
bool PlaybackItemSkippingEnabled {true}
 
bool PlaybackLooped {true}
 
double PlaybackRateFps {10.0}
 
bool RecordingActive {false}
 
int RecordingSamplingMode {vtkMRMLSequenceBrowserNode::SamplingLimitedToPlaybackFrameRate}
 
double RecordingTimeOffsetSec
 
bool RecordMasterOnly {false}
 
int SelectedItemNumber {-1}
 
std::vector< std::string > SynchronizationPostfixes
 
- 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 More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name {nullptr}
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene {true}
 
vtkWeakPointer< vtkMRMLSceneScene
 
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, vtkSmartPointer< vtkIntArray > > NodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 

Detailed Description

Definition at line 40 of file vtkMRMLSequenceBrowserNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkMRMLSequenceBrowserNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

ProxyNodeModifiedEvent is invoked when a proxy node is modified.

Enumerator
ProxyNodeModifiedEvent 
IndexDisplayFormatModifiedEvent 

Definition at line 48 of file vtkMRMLSequenceBrowserNode.h.

◆ IndexDisplayModeType

Modes displaying index for the user.

Enumerator
IndexDisplayAsIndex 
IndexDisplayAsIndexValue 
NumberOfIndexDisplayModes 

Definition at line 65 of file vtkMRMLSequenceBrowserNode.h.

◆ RecordingSamplingModeType

Modes for determining recording frame rate.

Enumerator
SamplingAll 
SamplingLimitedToPlaybackFrameRate 
NumberOfRecordingSamplingModes 

Definition at line 57 of file vtkMRMLSequenceBrowserNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLSequenceBrowserNode() [1/2]

vtkMRMLSequenceBrowserNode::vtkMRMLSequenceBrowserNode ( )
protected

◆ ~vtkMRMLSequenceBrowserNode()

vtkMRMLSequenceBrowserNode::~vtkMRMLSequenceBrowserNode ( )
overrideprotected

◆ vtkMRMLSequenceBrowserNode() [2/2]

vtkMRMLSequenceBrowserNode::vtkMRMLSequenceBrowserNode ( const vtkMRMLSequenceBrowserNode )
protected

Member Function Documentation

◆ AddProxyNode()

vtkMRMLNode* vtkMRMLSequenceBrowserNode::AddProxyNode ( vtkMRMLNode sourceProxyNode,
vtkMRMLSequenceNode sequenceNode,
bool  copy = true 
)

Adds proxy nodes from another scene (typically from the main scene). The data node is optionally copied.

◆ AddSynchronizedSequenceNode() [1/2]

std::string vtkMRMLSequenceBrowserNode::AddSynchronizedSequenceNode ( const char *  synchronizedSequenceNodeId)

Deprecated. Use AddSynchronizedSequenceNodeID instead.

◆ AddSynchronizedSequenceNode() [2/2]

std::string vtkMRMLSequenceBrowserNode::AddSynchronizedSequenceNode ( vtkMRMLSequenceNode synchronizedSequenceNode)

Adds a node for synchronized browsing. Returns the new proxy node postfix.

◆ AddSynchronizedSequenceNodeID()

std::string vtkMRMLSequenceBrowserNode::AddSynchronizedSequenceNodeID ( const char *  synchronizedSequenceNodeId)

Adds a node for synchronized browsing. Returns the new proxy node postfix.

◆ Copy()

void vtkMRMLSequenceBrowserNode::Copy ( vtkMRMLNode node)
overridevirtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLSequenceBrowserNode::CreateNodeInstance ( )
overridevirtual

Create instance of a GAD node.

Implements vtkMRMLNode.

◆ FixSequenceNodeReferenceRoleName()

void vtkMRMLSequenceBrowserNode::FixSequenceNodeReferenceRoleName ( )
protected

Earlier (before November 2015) sequenceNodeRef role name was rootNodeRef. Change the role name to the new one for compatibility with old data.

◆ GenerateSynchronizationPostfix()

std::string vtkMRMLSequenceBrowserNode::GenerateSynchronizationPostfix ( )
protected

◆ GetAllProxyNodes() [1/2]

void vtkMRMLSequenceBrowserNode::GetAllProxyNodes ( std::vector< vtkMRMLNode * > &  nodes)

◆ GetAllProxyNodes() [2/2]

void vtkMRMLSequenceBrowserNode::GetAllProxyNodes ( vtkCollection *  nodes)

◆ GetAllVirtualOutputDataNodes()

void vtkMRMLSequenceBrowserNode::GetAllVirtualOutputDataNodes ( vtkCollection *  nodes)
inline

Deprecated method!

Definition at line 245 of file vtkMRMLSequenceBrowserNode.h.

◆ GetClassName()

virtual const char* vtkMRMLSequenceBrowserNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLNode.

◆ GetFormattedIndexValue()

std::string vtkMRMLSequenceBrowserNode::GetFormattedIndexValue ( int  index)

Returns the formatted index value, formatted using the sprintf string provided by IndexDisplayFormat

See also
SetIndexDisplayFormat() GetIndexDisplayFormat()

◆ GetIndexDisplayFormat()

virtual std::string vtkMRMLSequenceBrowserNode::GetIndexDisplayFormat ( )
virtual

Get format of index value display.

◆ GetIndexDisplayMode()

virtual int vtkMRMLSequenceBrowserNode::GetIndexDisplayMode ( )
virtual

Get index display mode.

◆ GetIndexDisplayModeAsString() [1/2]

virtual std::string vtkMRMLSequenceBrowserNode::GetIndexDisplayModeAsString ( )
virtual

◆ GetIndexDisplayModeAsString() [2/2]

static std::string vtkMRMLSequenceBrowserNode::GetIndexDisplayModeAsString ( int  indexDisplayMode)
static

Helper functions for converting between string and code representation of index display modes.

◆ GetIndexDisplayModeFromString()

static int vtkMRMLSequenceBrowserNode::GetIndexDisplayModeFromString ( const std::string &  indexDisplayModeString)
static

◆ GetMasterSequenceNode()

vtkMRMLSequenceNode* vtkMRMLSequenceBrowserNode::GetMasterSequenceNode ( )

Get the sequence data node.

◆ GetNodeTagName()

const char* vtkMRMLSequenceBrowserNode::GetNodeTagName ( )
inlineoverridevirtual

Get unique node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 85 of file vtkMRMLSequenceBrowserNode.h.

◆ GetNumberOfItems()

int vtkMRMLSequenceBrowserNode::GetNumberOfItems ( )

Returns number of items in the sequence (number of data nodes in master sequence node)

◆ GetNumberOfSynchronizedSequenceNodes()

int vtkMRMLSequenceBrowserNode::GetNumberOfSynchronizedSequenceNodes ( bool  includeMasterNode = false)

Returns number of synchronized sequence nodes.

◆ GetOverwriteProxyName()

bool vtkMRMLSequenceBrowserNode::GetOverwriteProxyName ( vtkMRMLSequenceNode sequenceNode)

Overwrite proxy node name with name automatically generated from sequence base name and current item index.

◆ GetPlayback()

bool vtkMRMLSequenceBrowserNode::GetPlayback ( vtkMRMLSequenceNode sequenceNode)

◆ GetPlaybackActive()

virtual bool vtkMRMLSequenceBrowserNode::GetPlaybackActive ( )
virtual

Get/Set automatic playback (automatic continuous changing of selected sequence nodes)

◆ GetPlaybackItemSkippingEnabled()

virtual bool vtkMRMLSequenceBrowserNode::GetPlaybackItemSkippingEnabled ( )
virtual

Skipping items if necessary to reach requested playback rate. Enabled by default.

◆ GetPlaybackLooped()

virtual bool vtkMRMLSequenceBrowserNode::GetPlaybackLooped ( )
virtual

Get/Set playback looping (restart from the first sequence node when reached the last one)

◆ GetPlaybackRateFps()

virtual double vtkMRMLSequenceBrowserNode::GetPlaybackRateFps ( )
virtual

Get/Set playback rate in fps (frames per second)

◆ GetProxyNode()

vtkMRMLNode* vtkMRMLSequenceBrowserNode::GetProxyNode ( vtkMRMLSequenceNode sequenceNode)

Get proxy corresponding to a sequence node.

◆ GetRecording()

bool vtkMRMLSequenceBrowserNode::GetRecording ( vtkMRMLSequenceNode sequenceNode)

Get the synchronization properties for the given sequence/proxy tuple.

◆ GetRecordingActive()

virtual bool vtkMRMLSequenceBrowserNode::GetRecordingActive ( )
virtual

Get/set recording of proxy nodes.

◆ GetRecordingSamplingMode()

virtual int vtkMRMLSequenceBrowserNode::GetRecordingSamplingMode ( )
virtual

Get the recording sampling mode.

◆ GetRecordingSamplingModeAsString() [1/2]

virtual std::string vtkMRMLSequenceBrowserNode::GetRecordingSamplingModeAsString ( )
virtual

◆ GetRecordingSamplingModeAsString() [2/2]

static std::string vtkMRMLSequenceBrowserNode::GetRecordingSamplingModeAsString ( int  recordingSamplingMode)
static

Helper functions for converting between string and code representation of recording sampling modes.

◆ GetRecordingSamplingModeFromString()

static int vtkMRMLSequenceBrowserNode::GetRecordingSamplingModeFromString ( const std::string &  recordingSamplingModeString)
static

◆ GetRecordMasterOnly()

virtual bool vtkMRMLSequenceBrowserNode::GetRecordMasterOnly ( )
virtual

Get/set whether to only record when the master node is modified (or emits an observed event)

◆ GetSaveChanges()

bool vtkMRMLSequenceBrowserNode::GetSaveChanges ( vtkMRMLSequenceNode sequenceNode)

Enable saving of current proxy node state into the sequence. If saving is enabled then data is copied from the sequence to into the proxy node using shallow-copy, which is faster than deep-copy (that is used when save changes disabled). However, if save changes enabled, proxy node changes are stored in the sequence, therefore users may accidentally change sequence node content by modifying proxy nodes.

◆ GetSelectedItemNumber()

virtual int vtkMRMLSequenceBrowserNode::GetSelectedItemNumber ( )
virtual

Get/Set selected bundle index.

◆ GetSequenceNode()

vtkMRMLSequenceNode* vtkMRMLSequenceBrowserNode::GetSequenceNode ( vtkMRMLNode proxyNode)

Get sequence node corresponding to a proxy node.

◆ GetSynchronizationPostfixFromSequence()

std::string vtkMRMLSequenceBrowserNode::GetSynchronizationPostfixFromSequence ( vtkMRMLSequenceNode sequenceNode)
protected

◆ GetSynchronizationPostfixFromSequenceID()

std::string vtkMRMLSequenceBrowserNode::GetSynchronizationPostfixFromSequenceID ( const char *  sequenceNodeID)
protected

◆ GetSynchronizedSequenceNodes() [1/2]

void vtkMRMLSequenceBrowserNode::GetSynchronizedSequenceNodes ( std::vector< vtkMRMLSequenceNode * > &  synchronizedDataNodes,
bool  includeMasterNode = false 
)

Returns all synchronized sequence nodes (does not include the master sequence node)

◆ GetSynchronizedSequenceNodes() [2/2]

void vtkMRMLSequenceBrowserNode::GetSynchronizedSequenceNodes ( vtkCollection *  synchronizedDataNodes,
bool  includeMasterNode = false 
)

◆ GetVirtualOutputDataNode()

vtkMRMLNode* vtkMRMLSequenceBrowserNode::GetVirtualOutputDataNode ( vtkMRMLSequenceNode sequenceNode)
inline

Deprecated method!

Definition at line 201 of file vtkMRMLSequenceBrowserNode.h.

◆ IsA()

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

Reimplemented from vtkMRMLNode.

◆ IsAnySequenceNodeRecording()

bool vtkMRMLSequenceBrowserNode::IsAnySequenceNodeRecording ( )

Returns true if any of the sequence node is allowed to record.

◆ IsProxyNode()

bool vtkMRMLSequenceBrowserNode::IsProxyNode ( const char *  nodeId)

Deprecated. Use IsProxyNodeID instead.

◆ IsProxyNodeID()

bool vtkMRMLSequenceBrowserNode::IsProxyNodeID ( const char *  nodeId)

Returns true if the nodeId belongs to a proxy node managed by this browser node.

◆ IsSynchronizedSequenceNode() [1/2]

bool vtkMRMLSequenceBrowserNode::IsSynchronizedSequenceNode ( const char *  sequenceNodeId,
bool  includeMasterNode = false 
)

Deprecated. Use IsSynchronizedSequenceNodeID instead.

◆ IsSynchronizedSequenceNode() [2/2]

bool vtkMRMLSequenceBrowserNode::IsSynchronizedSequenceNode ( vtkMRMLSequenceNode sequenceNode,
bool  includeMasterNode = false 
)

◆ IsSynchronizedSequenceNodeID()

bool vtkMRMLSequenceBrowserNode::IsSynchronizedSequenceNodeID ( const char *  sequenceNodeId,
bool  includeMasterNode = false 
)

Returns true if the node is selected for synchronized browsing.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLSequenceBrowserNode* vtkMRMLSequenceBrowserNode::New ( )
static

◆ OnNodeReferenceAdded()

void vtkMRMLSequenceBrowserNode::OnNodeReferenceAdded ( vtkMRMLNodeReference nodeReference)
overrideprotectedvirtual

Called whenever a new node reference is added.

Reimplemented from vtkMRMLNode.

◆ operator=()

void vtkMRMLSequenceBrowserNode::operator= ( const vtkMRMLSequenceBrowserNode )
protected

◆ PlaybackActiveOff()

virtual void vtkMRMLSequenceBrowserNode::PlaybackActiveOff ( )
virtual

◆ PlaybackActiveOn()

virtual void vtkMRMLSequenceBrowserNode::PlaybackActiveOn ( )
virtual

◆ PlaybackItemSkippingEnabledOff()

virtual void vtkMRMLSequenceBrowserNode::PlaybackItemSkippingEnabledOff ( )
virtual

◆ PlaybackItemSkippingEnabledOn()

virtual void vtkMRMLSequenceBrowserNode::PlaybackItemSkippingEnabledOn ( )
virtual

◆ PlaybackLoopedOff()

virtual void vtkMRMLSequenceBrowserNode::PlaybackLoopedOff ( )
virtual

◆ PlaybackLoopedOn()

virtual void vtkMRMLSequenceBrowserNode::PlaybackLoopedOn ( )
virtual

◆ PrintSelf()

void vtkMRMLSequenceBrowserNode::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ ProcessMRMLEvents()

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

Process MRML node events for recording of the proxy nodes.

Reimplemented from vtkMRMLNode.

◆ ReadXMLAttributes()

void vtkMRMLSequenceBrowserNode::ReadXMLAttributes ( const char **  atts)
overridevirtual

Set node attributes from name/value pairs.

Reimplemented from vtkMRMLNode.

◆ RecordingActiveOff()

virtual void vtkMRMLSequenceBrowserNode::RecordingActiveOff ( )
virtual

◆ RecordingActiveOn()

virtual void vtkMRMLSequenceBrowserNode::RecordingActiveOn ( )
virtual

◆ RecordMasterOnlyOff()

virtual void vtkMRMLSequenceBrowserNode::RecordMasterOnlyOff ( )
virtual

◆ RecordMasterOnlyOn()

virtual void vtkMRMLSequenceBrowserNode::RecordMasterOnlyOn ( )
virtual

◆ RemoveAllProxyNodes()

void vtkMRMLSequenceBrowserNode::RemoveAllProxyNodes ( )

◆ RemoveAllSequenceNodes()

void vtkMRMLSequenceBrowserNode::RemoveAllSequenceNodes ( )

Remove all sequence nodes (including the master sequence node)

◆ RemoveProxyNode()

void vtkMRMLSequenceBrowserNode::RemoveProxyNode ( const std::string &  postfix)

◆ RemoveSynchronizedSequenceNode()

void vtkMRMLSequenceBrowserNode::RemoveSynchronizedSequenceNode ( const char *  nodeId)

Removes a node from synchronized browsing.

◆ SafeDownCast()

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

◆ SaveProxyNodesState()

virtual void vtkMRMLSequenceBrowserNode::SaveProxyNodesState ( )
virtual

Save state of all proxy nodes that recording is enabled for.

◆ SelectFirstItem()

int vtkMRMLSequenceBrowserNode::SelectFirstItem ( )

Selects first sequence item for display, returns current selected item number.

◆ SelectLastItem()

int vtkMRMLSequenceBrowserNode::SelectLastItem ( )

Selects last sequence item for display, returns current selected item number.

◆ SelectNextItem()

int vtkMRMLSequenceBrowserNode::SelectNextItem ( int  selectionIncrement = 1)

Selects the next sequence item for display, returns current selected item number.

◆ SetAndObserveMasterSequenceNodeID()

std::string vtkMRMLSequenceBrowserNode::SetAndObserveMasterSequenceNodeID ( const char *  sequenceNodeID)

Set the sequence data node. Returns the new proxy node postfix.

◆ SetDeepCopyVirtualNodes()

void vtkMRMLSequenceBrowserNode::SetDeepCopyVirtualNodes ( bool  deepcopy)
inline

Deprecated method!

Definition at line 226 of file vtkMRMLSequenceBrowserNode.h.

◆ SetIndexDisplayFormat()

void vtkMRMLSequenceBrowserNode::SetIndexDisplayFormat ( std::string  displayFormat)

Set format of index value display.

◆ SetIndexDisplayMode()

virtual void vtkMRMLSequenceBrowserNode::SetIndexDisplayMode ( int  )
virtual

Set index display mode.

◆ SetIndexDisplayModeFromString()

void vtkMRMLSequenceBrowserNode::SetIndexDisplayModeFromString ( const char *  indexDisplayModeString)

◆ SetOverwriteProxyName()

void vtkMRMLSequenceBrowserNode::SetOverwriteProxyName ( vtkMRMLSequenceNode sequenceNode,
bool  overwrite 
)

◆ SetOverwriteTargetNodeName()

void vtkMRMLSequenceBrowserNode::SetOverwriteTargetNodeName ( bool  overwrite)
inline

Deprecated method!

Definition at line 213 of file vtkMRMLSequenceBrowserNode.h.

◆ SetPlayback()

void vtkMRMLSequenceBrowserNode::SetPlayback ( vtkMRMLSequenceNode sequenceNode,
bool  playback 
)

◆ SetPlaybackActive()

virtual void vtkMRMLSequenceBrowserNode::SetPlaybackActive ( bool  )
virtual

◆ SetPlaybackItemSkippingEnabled()

virtual void vtkMRMLSequenceBrowserNode::SetPlaybackItemSkippingEnabled ( bool  )
virtual

◆ SetPlaybackLooped()

virtual void vtkMRMLSequenceBrowserNode::SetPlaybackLooped ( bool  )
virtual

◆ SetPlaybackRateFps()

virtual void vtkMRMLSequenceBrowserNode::SetPlaybackRateFps ( double  )
virtual

◆ SetRecording()

void vtkMRMLSequenceBrowserNode::SetRecording ( vtkMRMLSequenceNode sequenceNode,
bool  recording 
)

Set the synchrnization properties for the given sequence/proxy tuple.

◆ SetRecordingActive()

void vtkMRMLSequenceBrowserNode::SetRecordingActive ( bool  recording)

◆ SetRecordingSamplingMode()

virtual void vtkMRMLSequenceBrowserNode::SetRecordingSamplingMode ( int  )
virtual

Set the recording sampling mode.

◆ SetRecordingSamplingModeFromString()

void vtkMRMLSequenceBrowserNode::SetRecordingSamplingModeFromString ( const char *  recordingSamplingModeString)

◆ SetRecordMasterOnly()

virtual void vtkMRMLSequenceBrowserNode::SetRecordMasterOnly ( bool  )
virtual

◆ SetSaveChanges()

void vtkMRMLSequenceBrowserNode::SetSaveChanges ( vtkMRMLSequenceNode sequenceNode,
bool  save 
)

◆ SetSelectedItemNumber()

virtual void vtkMRMLSequenceBrowserNode::SetSelectedItemNumber ( int  )
virtual

◆ ValidateFormatString()

static bool vtkMRMLSequenceBrowserNode::ValidateFormatString ( std::string &  validatedFormat,
std::string &  prefix,
std::string &  suffix,
const std::string &  requestedFormat,
const std::string &  typeString 
)
static

Parses the requestedFormat string to find a validated format for the types contained in typeString. validatedFormat is set to the first matching sprintf for the input types prefix and suffix are set to the non-matching components of requestedFormat

◆ WriteXML()

void vtkMRMLSequenceBrowserNode::WriteXML ( ostream &  of,
int  indent 
)
overridevirtual

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

Reimplemented from vtkMRMLNode.

Member Data Documentation

◆ IndexDisplayFormat

std::string vtkMRMLSequenceBrowserNode::IndexDisplayFormat
protected

Definition at line 335 of file vtkMRMLSequenceBrowserNode.h.

◆ IndexDisplayMode

int vtkMRMLSequenceBrowserNode::IndexDisplayMode {vtkMRMLSequenceBrowserNode::IndexDisplayAsIndexValue}
protected

Definition at line 334 of file vtkMRMLSequenceBrowserNode.h.

◆ LastPostfixIndex

int vtkMRMLSequenceBrowserNode::LastPostfixIndex {0}
protected

Definition at line 342 of file vtkMRMLSequenceBrowserNode.h.

◆ LastSaveProxyNodesStateTimeSec

double vtkMRMLSequenceBrowserNode::LastSaveProxyNodesStateTimeSec
protected

Definition at line 331 of file vtkMRMLSequenceBrowserNode.h.

◆ PlaybackActive

bool vtkMRMLSequenceBrowserNode::PlaybackActive {false}
protected

Definition at line 323 of file vtkMRMLSequenceBrowserNode.h.

◆ PlaybackItemSkippingEnabled

bool vtkMRMLSequenceBrowserNode::PlaybackItemSkippingEnabled {true}
protected

Definition at line 325 of file vtkMRMLSequenceBrowserNode.h.

◆ PlaybackLooped

bool vtkMRMLSequenceBrowserNode::PlaybackLooped {true}
protected

Definition at line 326 of file vtkMRMLSequenceBrowserNode.h.

◆ PlaybackRateFps

double vtkMRMLSequenceBrowserNode::PlaybackRateFps {10.0}
protected

Definition at line 324 of file vtkMRMLSequenceBrowserNode.h.

◆ RecordingActive

bool vtkMRMLSequenceBrowserNode::RecordingActive {false}
protected

Definition at line 329 of file vtkMRMLSequenceBrowserNode.h.

◆ RecordingSamplingMode

int vtkMRMLSequenceBrowserNode::RecordingSamplingMode {vtkMRMLSequenceBrowserNode::SamplingLimitedToPlaybackFrameRate}
protected

Definition at line 333 of file vtkMRMLSequenceBrowserNode.h.

◆ RecordingTimeOffsetSec

double vtkMRMLSequenceBrowserNode::RecordingTimeOffsetSec
protected

Definition at line 330 of file vtkMRMLSequenceBrowserNode.h.

◆ RecordMasterOnly

bool vtkMRMLSequenceBrowserNode::RecordMasterOnly {false}
protected

Definition at line 332 of file vtkMRMLSequenceBrowserNode.h.

◆ SelectedItemNumber

int vtkMRMLSequenceBrowserNode::SelectedItemNumber {-1}
protected

Definition at line 327 of file vtkMRMLSequenceBrowserNode.h.

◆ SynchronizationPostfixes

std::vector< std::string > vtkMRMLSequenceBrowserNode::SynchronizationPostfixes
protected

Definition at line 339 of file vtkMRMLSequenceBrowserNode.h.


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