![]() |
Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
#include <Modules/Loadable/Sequences/MRML/vtkMRMLSequenceBrowserNode.h>
Public Member Functions | |
vtkMRMLNode * | 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. | |
std::string | AddSynchronizedSequenceNode (const char *synchronizedSequenceNodeId) |
Deprecated. Use AddSynchronizedSequenceNodeID instead. | |
std::string | AddSynchronizedSequenceNode (vtkMRMLSequenceNode *synchronizedSequenceNode) |
Adds a node for synchronized browsing. Returns the new proxy node postfix. | |
std::string | AddSynchronizedSequenceNodeID (const char *synchronizedSequenceNodeId) |
Adds a node for synchronized browsing. Returns the new proxy node postfix. | |
void | Copy (vtkMRMLNode *node) override |
Copy the node's attributes to this object. | |
vtkMRMLNode * | CreateNodeInstance () override |
Create instance of a GAD node. | |
void | GetAllProxyNodes (std::vector< vtkMRMLNode * > &nodes) |
void | GetAllProxyNodes (vtkCollection *nodes) |
void | GetAllVirtualOutputDataNodes (vtkCollection *nodes) |
Deprecated method! | |
virtual const char * | GetClassName () |
std::string | GetFormattedIndexValue (int index) |
virtual std::string | GetIndexDisplayFormat () |
virtual int | GetIndexDisplayMode () |
virtual std::string | GetIndexDisplayModeAsString () |
vtkMRMLSequenceNode * | GetMasterSequenceNode () |
Get the sequence data node. | |
MissingItemModeType | GetMissingItemMode (vtkMRMLSequenceNode *sequenceNode) |
const char * | GetNodeTagName () override |
Get unique node XML tag name (like Volume, Model) | |
int | GetNumberOfItems () |
Returns number of items in the sequence (number of data nodes in master sequence node) | |
int | GetNumberOfSynchronizedSequenceNodes (bool includeMasterNode=false) |
Returns number of synchronized sequence nodes. | |
bool | GetOverwriteProxyName (vtkMRMLSequenceNode *sequenceNode) |
Overwrite proxy node name with name automatically generated from sequence base name and current item index. | |
bool | GetPlayback (vtkMRMLSequenceNode *sequenceNode) |
Update the proxy node with the content of the sequence. | |
virtual bool | GetPlaybackActive () |
Get/Set automatic playback (automatic continuous changing of selected sequence nodes) | |
virtual bool | GetPlaybackItemSkippingEnabled () |
Skipping items if necessary to reach requested playback rate. Enabled by default. | |
virtual bool | GetPlaybackLooped () |
Get/Set playback looping (restart from the first sequence node when reached the last one) | |
virtual double | GetPlaybackRateFps () |
Get/Set playback rate in fps (frames per second) | |
vtkMRMLNode * | GetProxyNode (vtkMRMLSequenceNode *sequenceNode) |
Get proxy corresponding to a sequence node. | |
bool | GetRecording (vtkMRMLSequenceNode *sequenceNode) |
Add new items to the sequence when sequence recording is activated. | |
virtual bool | GetRecordingActive () |
Get/set recording of proxy nodes. | |
virtual int | GetRecordingSamplingMode () |
virtual std::string | GetRecordingSamplingModeAsString () |
virtual bool | GetRecordMasterOnly () |
Get/set whether to only record when the master node is modified (or emits an observed event) | |
bool | GetSaveChanges (vtkMRMLSequenceNode *sequenceNode) |
virtual int | GetSelectedItemNumber () |
Get/Set selected item number. Item number is an integer between 0 and (NumberOfItems - 1). | |
vtkMRMLSequenceNode * | GetSequenceNode (vtkMRMLNode *proxyNode) |
Get sequence node corresponding to a proxy node. | |
void | GetSynchronizedSequenceNodes (std::vector< vtkMRMLSequenceNode * > &synchronizedDataNodes, bool includeMasterNode=false) |
Returns all synchronized sequence nodes (does not include the master sequence node) | |
void | GetSynchronizedSequenceNodes (vtkCollection *synchronizedDataNodes, bool includeMasterNode=false) |
vtkMRMLNode * | GetVirtualOutputDataNode (vtkMRMLSequenceNode *sequenceNode) |
Deprecated method! | |
virtual int | IsA (const char *type) |
bool | IsAnySequenceNodeRecording () |
Returns true if any of the sequence node is allowed to record. | |
bool | IsProxyNode (const char *nodeId) |
Deprecated. Use IsProxyNodeID instead. | |
bool | IsProxyNodeID (const char *nodeId) |
Returns true if the nodeId belongs to a proxy node managed by this browser node. | |
bool | IsSynchronizedSequenceNode (const char *sequenceNodeId, bool includeMasterNode=false) |
Deprecated. Use IsSynchronizedSequenceNodeID instead. | |
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. | |
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. | |
void | ReadXMLAttributes (const char **atts) override |
Set node attributes from name/value pairs. | |
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) | |
void | RemoveProxyNode (const std::string &postfix) |
void | RemoveSynchronizedSequenceNode (const char *nodeId) |
Removes a node from synchronized browsing. | |
virtual void | SaveProxyNodesState () |
Save state of all proxy nodes that recording is enabled for. | |
int | SelectFirstItem () |
int | SelectLastItem () |
int | SelectNextItem (int selectionIncrement=1) |
Selects a sequence item for display, returns current selected item number. | |
std::string | SetAndObserveMasterSequenceNodeID (const char *sequenceNodeID) |
void | SetDeepCopyVirtualNodes (bool deepcopy) |
Deprecated method! | |
void | SetIndexDisplayFormat (std::string displayFormat) |
Get/set format of index value display (used if index type is numeric) | |
virtual void | SetIndexDisplayMode (int) |
Get/set index display mode. | |
void | SetIndexDisplayModeFromString (const char *indexDisplayModeString) |
void | SetMissingItemMode (vtkMRMLSequenceNode *sequenceNode, MissingItemModeType missingItemMode) |
void | SetOverwriteProxyName (vtkMRMLSequenceNode *sequenceNode, bool overwrite) |
void | SetOverwriteTargetNodeName (bool overwrite) |
Deprecated method! | |
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) |
void | SetRecordingActive (bool recording) |
virtual void | SetRecordingSamplingMode (int) |
Get/set the recording sampling mode. | |
void | SetRecordingSamplingModeFromString (const char *recordingSamplingModeString) |
virtual void | SetRecordMasterOnly (bool) |
void | SetSaveChanges (vtkMRMLSequenceNode *sequenceNode, bool save) |
bool | SetSelectedItemByIndexValue (const std::string &indexValue, bool exactMatchRequired=true) |
virtual void | SetSelectedItemNumber (int) |
void | WriteXML (ostream &of, int indent) override |
Write this node's information to a MRML file in XML format. | |
![]() | |
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. | |
virtual void | UpdateScene (vtkMRMLScene *) |
const char * | URLDecodeString (const char *inString) |
Decode a URL string. | |
const char * | URLEncodeString (const char *inString) |
Encode a URL string. | |
virtual void | WriteNodeBodyXML (ostream &of, int indent) |
Write this node's body to a MRML file in XML format. | |
std::string | XMLAttributeDecodeString (const std::string &inString) |
Decode an XML attribute string. | |
std::string | XMLAttributeEncodeString (const std::string &inString) |
Encode an XML attribute string (replaces special characters by code sequences) | |
Static Public Member Functions | |
static std::string | GetIndexDisplayModeAsString (int indexDisplayMode) |
Helper functions for converting between string and code representation of index display modes. | |
static int | GetIndexDisplayModeFromString (const std::string &indexDisplayModeString) |
static std::string | GetMissingItemModeAsString (int missingItemMode) |
Helper functions for converting between string and code representation of recording sampling modes. | |
static MissingItemModeType | GetMissingItemModeFromString (const std::string &missingItemModeString) |
static std::string | GetRecordingSamplingModeAsString (int recordingSamplingMode) |
Helper functions for converting between string and code representation of recording sampling modes. | |
static int | GetRecordingSamplingModeFromString (const std::string &recordingSamplingModeString) |
static int | IsTypeOf (const char *type) |
static vtkMRMLSequenceBrowserNode * | New () |
static vtkMRMLSequenceBrowserNode * | SafeDownCast (vtkObject *o) |
static bool | ValidateFormatString (std::string &validatedFormat, std::string &prefix, std::string &suffix, const std::string &requestedFormat, const std::string &typeString) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkMRMLNode * | SafeDownCast (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. | |
void | OnNodeReferenceRemoved (vtkMRMLNodeReference *nodeReference) override |
Called whenever a node reference is removed. | |
void | operator= (const vtkMRMLSequenceBrowserNode &) |
vtkMRMLSequenceBrowserNode () | |
vtkMRMLSequenceBrowserNode (const vtkMRMLSequenceBrowserNode &) | |
~vtkMRMLSequenceBrowserNode () override | |
![]() | |
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 | OnNodeReferenceModified (vtkMRMLNodeReference *reference) |
Called when a referenced node pointer is modified. | |
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! | |
Additional Inherited Members | |
![]() | |
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 void | MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData) |
Definition at line 40 of file vtkMRMLSequenceBrowserNode.h.
Definition at line 44 of file vtkMRMLSequenceBrowserNode.h.
anonymous enum |
ProxyNodeModifiedEvent is invoked when a proxy node is modified.
Enumerator | |
---|---|
ProxyNodeModifiedEvent | |
IndexDisplayFormatModifiedEvent | |
SequenceNodeModifiedEvent |
Definition at line 48 of file vtkMRMLSequenceBrowserNode.h.
Modes displaying index for the user.
Enumerator | |
---|---|
IndexDisplayAsIndex | |
IndexDisplayAsIndexValue | |
NumberOfIndexDisplayModes |
Definition at line 77 of file vtkMRMLSequenceBrowserNode.h.
Specify what happens when during sequence browsing if a sequence does not contain an item for the current index.
Definition at line 67 of file vtkMRMLSequenceBrowserNode.h.
Modes for determining recording frame rate.
Enumerator | |
---|---|
SamplingAll | |
SamplingLimitedToPlaybackFrameRate | |
NumberOfRecordingSamplingModes |
Definition at line 58 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
|
overrideprotected |
|
protected |
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.
std::string vtkMRMLSequenceBrowserNode::AddSynchronizedSequenceNode | ( | const char * | synchronizedSequenceNodeId | ) |
Deprecated. Use AddSynchronizedSequenceNodeID instead.
std::string vtkMRMLSequenceBrowserNode::AddSynchronizedSequenceNode | ( | vtkMRMLSequenceNode * | synchronizedSequenceNode | ) |
Adds a node for synchronized browsing. Returns the new proxy node postfix.
std::string vtkMRMLSequenceBrowserNode::AddSynchronizedSequenceNodeID | ( | const char * | synchronizedSequenceNodeId | ) |
Adds a node for synchronized browsing. Returns the new proxy node postfix.
|
overridevirtual |
Copy the node's attributes to this object.
Reimplemented from vtkMRMLNode.
|
overridevirtual |
Create instance of a GAD node.
Implements vtkMRMLNode.
|
protected |
Earlier (before November 2015) sequenceNodeRef role name was rootNodeRef. Change the role name to the new one for compatibility with old data.
|
protected |
void vtkMRMLSequenceBrowserNode::GetAllProxyNodes | ( | std::vector< vtkMRMLNode * > & | nodes | ) |
void vtkMRMLSequenceBrowserNode::GetAllProxyNodes | ( | vtkCollection * | nodes | ) |
|
inline |
Deprecated method!
Definition at line 291 of file vtkMRMLSequenceBrowserNode.h.
|
virtual |
Reimplemented from vtkMRMLNode.
std::string vtkMRMLSequenceBrowserNode::GetFormattedIndexValue | ( | int | index | ) |
Returns the formatted index value, formatted using the sprintf string provided by IndexDisplayFormat
|
virtual |
|
virtual |
|
virtual |
|
static |
Helper functions for converting between string and code representation of index display modes.
|
static |
vtkMRMLSequenceNode * vtkMRMLSequenceBrowserNode::GetMasterSequenceNode | ( | ) |
Get the sequence data node.
MissingItemModeType vtkMRMLSequenceBrowserNode::GetMissingItemMode | ( | vtkMRMLSequenceNode * | sequenceNode | ) |
Specify what happens when during sequence browsing if a sequence does not contain an item for the current index.
|
static |
Helper functions for converting between string and code representation of recording sampling modes.
|
static |
|
inlineoverridevirtual |
Get unique node XML tag name (like Volume, Model)
Implements vtkMRMLNode.
Definition at line 97 of file vtkMRMLSequenceBrowserNode.h.
int vtkMRMLSequenceBrowserNode::GetNumberOfItems | ( | ) |
Returns number of items in the sequence (number of data nodes in master sequence node)
int vtkMRMLSequenceBrowserNode::GetNumberOfSynchronizedSequenceNodes | ( | bool | includeMasterNode = false | ) |
Returns number of synchronized sequence nodes.
bool vtkMRMLSequenceBrowserNode::GetOverwriteProxyName | ( | vtkMRMLSequenceNode * | sequenceNode | ) |
Overwrite proxy node name with name automatically generated from sequence base name and current item index.
bool vtkMRMLSequenceBrowserNode::GetPlayback | ( | vtkMRMLSequenceNode * | sequenceNode | ) |
Update the proxy node with the content of the sequence.
|
virtual |
Get/Set automatic playback (automatic continuous changing of selected sequence nodes)
|
virtual |
Skipping items if necessary to reach requested playback rate. Enabled by default.
|
virtual |
Get/Set playback looping (restart from the first sequence node when reached the last one)
|
virtual |
Get/Set playback rate in fps (frames per second)
vtkMRMLNode * vtkMRMLSequenceBrowserNode::GetProxyNode | ( | vtkMRMLSequenceNode * | sequenceNode | ) |
Get proxy corresponding to a sequence node.
bool vtkMRMLSequenceBrowserNode::GetRecording | ( | vtkMRMLSequenceNode * | sequenceNode | ) |
Add new items to the sequence when sequence recording is activated.
|
virtual |
Get/set recording of proxy nodes.
|
virtual |
|
virtual |
|
static |
Helper functions for converting between string and code representation of recording sampling modes.
|
static |
|
virtual |
Get/set whether to only record when the master node is modified (or emits an observed event)
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.
|
virtual |
Get/Set selected item number. Item number is an integer between 0 and (NumberOfItems - 1).
vtkMRMLSequenceNode * vtkMRMLSequenceBrowserNode::GetSequenceNode | ( | vtkMRMLNode * | proxyNode | ) |
Get sequence node corresponding to a proxy node.
|
protected |
|
protected |
void vtkMRMLSequenceBrowserNode::GetSynchronizedSequenceNodes | ( | std::vector< vtkMRMLSequenceNode * > & | synchronizedDataNodes, |
bool | includeMasterNode = false ) |
Returns all synchronized sequence nodes (does not include the master sequence node)
void vtkMRMLSequenceBrowserNode::GetSynchronizedSequenceNodes | ( | vtkCollection * | synchronizedDataNodes, |
bool | includeMasterNode = false ) |
|
inline |
Deprecated method!
Definition at line 248 of file vtkMRMLSequenceBrowserNode.h.
|
virtual |
Reimplemented from vtkMRMLNode.
bool vtkMRMLSequenceBrowserNode::IsAnySequenceNodeRecording | ( | ) |
Returns true if any of the sequence node is allowed to record.
bool vtkMRMLSequenceBrowserNode::IsProxyNode | ( | const char * | nodeId | ) |
Deprecated. Use IsProxyNodeID instead.
bool vtkMRMLSequenceBrowserNode::IsProxyNodeID | ( | const char * | nodeId | ) |
Returns true if the nodeId belongs to a proxy node managed by this browser node.
bool vtkMRMLSequenceBrowserNode::IsSynchronizedSequenceNode | ( | const char * | sequenceNodeId, |
bool | includeMasterNode = false ) |
Deprecated. Use IsSynchronizedSequenceNodeID instead.
bool vtkMRMLSequenceBrowserNode::IsSynchronizedSequenceNode | ( | vtkMRMLSequenceNode * | sequenceNode, |
bool | includeMasterNode = false ) |
bool vtkMRMLSequenceBrowserNode::IsSynchronizedSequenceNodeID | ( | const char * | sequenceNodeId, |
bool | includeMasterNode = false ) |
Returns true if the node is selected for synchronized browsing.
|
static |
|
static |
|
overrideprotectedvirtual |
Called whenever a new node reference is added.
Reimplemented from vtkMRMLNode.
|
overrideprotectedvirtual |
Called whenever a node reference is removed.
Reimplemented from vtkMRMLNode.
|
protected |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
override |
|
overridevirtual |
Process MRML node events for recording of the proxy nodes.
Reimplemented from vtkMRMLNode.
|
overridevirtual |
Set node attributes from name/value pairs.
Reimplemented from vtkMRMLNode.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
void vtkMRMLSequenceBrowserNode::RemoveAllProxyNodes | ( | ) |
void vtkMRMLSequenceBrowserNode::RemoveAllSequenceNodes | ( | ) |
Remove all sequence nodes (including the master sequence node)
void vtkMRMLSequenceBrowserNode::RemoveProxyNode | ( | const std::string & | postfix | ) |
void vtkMRMLSequenceBrowserNode::RemoveSynchronizedSequenceNode | ( | const char * | nodeId | ) |
Removes a node from synchronized browsing.
|
static |
|
virtual |
Save state of all proxy nodes that recording is enabled for.
int vtkMRMLSequenceBrowserNode::SelectFirstItem | ( | ) |
int vtkMRMLSequenceBrowserNode::SelectLastItem | ( | ) |
int vtkMRMLSequenceBrowserNode::SelectNextItem | ( | int | selectionIncrement = 1 | ) |
Selects a sequence item for display, returns current selected item number.
std::string vtkMRMLSequenceBrowserNode::SetAndObserveMasterSequenceNodeID | ( | const char * | sequenceNodeID | ) |
Set the sequence data node. Returns the new proxy node postfix.
|
inline |
Deprecated method!
Definition at line 273 of file vtkMRMLSequenceBrowserNode.h.
void vtkMRMLSequenceBrowserNode::SetIndexDisplayFormat | ( | std::string | displayFormat | ) |
Get/set format of index value display (used if index type is numeric)
|
virtual |
Get/set index display mode.
void vtkMRMLSequenceBrowserNode::SetIndexDisplayModeFromString | ( | const char * | indexDisplayModeString | ) |
void vtkMRMLSequenceBrowserNode::SetMissingItemMode | ( | vtkMRMLSequenceNode * | sequenceNode, |
MissingItemModeType | missingItemMode ) |
void vtkMRMLSequenceBrowserNode::SetOverwriteProxyName | ( | vtkMRMLSequenceNode * | sequenceNode, |
bool | overwrite ) |
|
inline |
Deprecated method!
Definition at line 260 of file vtkMRMLSequenceBrowserNode.h.
void vtkMRMLSequenceBrowserNode::SetPlayback | ( | vtkMRMLSequenceNode * | sequenceNode, |
bool | playback ) |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
void vtkMRMLSequenceBrowserNode::SetRecording | ( | vtkMRMLSequenceNode * | sequenceNode, |
bool | recording ) |
void vtkMRMLSequenceBrowserNode::SetRecordingActive | ( | bool | recording | ) |
|
virtual |
Get/set the recording sampling mode.
void vtkMRMLSequenceBrowserNode::SetRecordingSamplingModeFromString | ( | const char * | recordingSamplingModeString | ) |
|
virtual |
void vtkMRMLSequenceBrowserNode::SetSaveChanges | ( | vtkMRMLSequenceNode * | sequenceNode, |
bool | save ) |
bool vtkMRMLSequenceBrowserNode::SetSelectedItemByIndexValue | ( | const std::string & | indexValue, |
bool | exactMatchRequired = true ) |
Set selected item by index value. If exact match is not required and index is numeric then the best matching data node is returned. Returns true if the index value is found.
|
virtual |
|
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
|
overridevirtual |
Write this node's information to a MRML file in XML format.
Reimplemented from vtkMRMLNode.
|
protected |
Definition at line 402 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 401 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 409 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 398 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 390 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 392 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 393 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 391 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 396 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 400 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 397 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 399 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 394 of file vtkMRMLSequenceBrowserNode.h.
|
protected |
Definition at line 406 of file vtkMRMLSequenceBrowserNode.h.