Slicer
4.10
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
#include <Modules/Loadable/Markups/Logic/vtkSlicerMarkupsLogic.h>
Public Types | |
typedef vtkSlicerModuleLogic | Superclass |
Public Types inherited from vtkSlicerModuleLogic | |
typedef vtkMRMLAbstractLogic | Superclass |
Public Types inherited from vtkMRMLAbstractLogic | |
typedef vtkObject | Superclass |
typedef void(vtkMRMLAbstractLogic::* | TaskFunctionPointer) (void *clientdata) |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkSlicerMarkupsLogic * | New () |
static vtkSlicerMarkupsLogic * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkSlicerModuleLogic | |
static int | IsTypeOf (const char *type) |
static vtkSlicerModuleLogic * | New () |
The Usual vtk class functions. More... | |
static vtkSlicerModuleLogic * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkMRMLAbstractLogic | |
static int | IsTypeOf (const char *type) |
static vtkMRMLAbstractLogic * | New () |
static vtkMRMLAbstractLogic * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
virtual void | ObserveMRMLScene () VTK_OVERRIDE |
virtual void | OnMRMLSceneNodeAdded (vtkMRMLNode *node) VTK_OVERRIDE |
virtual void | OnMRMLSceneNodeRemoved (vtkMRMLNode *node) VTK_OVERRIDE |
virtual void | RegisterNodes () VTK_OVERRIDE |
Register MRML Node classes to Scene. Gets called automatically when the MRMLScene is attached to this logic class. More... | |
virtual void | SetMRMLSceneInternal (vtkMRMLScene *newScene) VTK_OVERRIDE |
Initialize listening to MRML events. More... | |
virtual void | UpdateFromMRMLScene () VTK_OVERRIDE |
vtkSlicerMarkupsLogic () | |
virtual | ~vtkSlicerMarkupsLogic () |
Protected Member Functions inherited from vtkSlicerModuleLogic | |
vtkSlicerModuleLogic () | |
virtual | ~vtkSlicerModuleLogic () |
Protected Member Functions inherited from vtkMRMLAbstractLogic | |
int | EndModify (bool wasModifying) |
virtual bool | EnterMRMLLogicsCallback () const |
virtual bool | EnterMRMLNodesCallback () const |
virtual bool | EnterMRMLSceneCallback () const |
bool | GetDisableModifiedEvent () const |
int | GetInMRMLLogicsCallbackFlag () const |
int | GetInMRMLNodesCallbackFlag () const |
int | GetInMRMLSceneCallbackFlag () const |
vtkCallbackCommand * | GetMRMLLogicsCallbackCommand () |
vtkObserverManager * | GetMRMLLogicsObserverManager () const |
vtkCallbackCommand * | GetMRMLNodesCallbackCommand () |
vtkObserverManager * | GetMRMLNodesObserverManager () const |
vtkCallbackCommand * | GetMRMLSceneCallbackCommand () |
vtkObserverManager * | GetMRMLSceneObserverManager () const |
int | GetPendingModifiedEventCount () const |
int | GetProcessingMRMLSceneEvent () const |
Return the event id currently processed or 0 if any. More... | |
int | InvokePendingModifiedEvent () |
virtual void | Modified () VTK_OVERRIDE |
virtual void | OnMRMLNodeModified (vtkMRMLNode *) |
virtual void | OnMRMLSceneEndBatchProcess () |
virtual void | OnMRMLSceneEndClose () |
virtual void | OnMRMLSceneEndImport () |
virtual void | OnMRMLSceneEndRestore () |
virtual void | OnMRMLSceneNew () |
virtual void | OnMRMLSceneStartBatchProcess () |
virtual void | OnMRMLSceneStartClose () |
virtual void | OnMRMLSceneStartImport () |
virtual void | OnMRMLSceneStartRestore () |
virtual void | ProcessMRMLLogicsEvents (vtkObject *caller, unsigned long event, void *callData) |
virtual void | ProcessMRMLSceneEvents (vtkObject *caller, unsigned long event, void *callData) |
void | SetAndObserveMRMLSceneEventsInternal (vtkMRMLScene *newScene, vtkIntArray *events, vtkFloatArray *priorities=0) |
void | SetDisableModifiedEvent (bool onOff) |
void | SetInMRMLLogicsCallbackFlag (int flag) |
void | SetInMRMLNodesCallbackFlag (int flag) |
void | SetInMRMLSceneCallbackFlag (int flag) |
void | SetProcessingMRMLSceneEvent (int event) |
bool | StartModify () |
virtual void | UnobserveMRMLScene () |
vtkMRMLAbstractLogic () | |
virtual | ~vtkMRMLAbstractLogic () |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkMRMLAbstractLogic | |
static void | MRMLLogicsCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData) |
MRMLLogicCallback is a static function to relay modified events from the logics. More... | |
static void | MRMLNodesCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData) |
MRMLNodesCallback is a static function to relay modified events from the nodes. More... | |
static void | MRMLSceneCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData) |
Definition at line 41 of file vtkSlicerMarkupsLogic.h.
Definition at line 47 of file vtkSlicerMarkupsLogic.h.
|
protected |
|
protectedvirtual |
int vtkSlicerMarkupsLogic::AddFiducial | ( | double | r = 0.0 , |
double | a = 0.0 , |
||
double | s = 0.0 |
||
) |
Add a new fiducial to the currently active list at the given RAS coordinates (default 0,0,0). Will create a list is one is not active. Returns -1 on failure, index of the added fiducial on success.
std::string vtkSlicerMarkupsLogic::AddNewDisplayNodeForMarkupsNode | ( | vtkMRMLNode * | mrmlNode | ) |
Create a new display node and observe it on the markups node. On success, return the id, on failure return an empty string. If a display node already exists for this node, return the id of that node.
std::string vtkSlicerMarkupsLogic::AddNewFiducialNode | ( | const char * | name = "F" , |
vtkMRMLScene * | scene = NULL |
||
) |
Create a new markups fiducial node and associated display node, adding both to the scene. If the scene argument is null use the scene set on the logic class, and also make it the active on on the selection node, otherwise add to the passed scene. On success, return the id, on failure return an empty string.
void vtkSlicerMarkupsLogic::ConvertAnnotationFiducialsToMarkups | ( | ) |
Searches the scene for annotation fidicual nodes, collecting a list of annotation hierarchy nodes. Then iterates through those hierarchy nodes and moves the fiducials that are under them into new markups nodes. Leaves the top level hierarchy nodes intact as they may be parents to ruler or ROIs but deletes the 1:1 hierarchy nodes.
bool vtkSlicerMarkupsLogic::CopyNthMarkupToNewList | ( | int | n, |
vtkMRMLMarkupsNode * | markupsNode, | ||
vtkMRMLMarkupsNode * | newMarkupsNode | ||
) |
utility method to copy a markup from one list to another, adding it to the end of the new list
void vtkSlicerMarkupsLogic::FocusCameraOnNthPointInMarkup | ( | const char * | cameraNodeID, |
const char * | markupNodeID, | ||
int | n | ||
) |
refocus the camera with the given cameraNodeID on the nth markup in the markups node with id markupNodeID
void vtkSlicerMarkupsLogic::FocusCamerasOnNthPointInMarkup | ( | const char * | id, |
int | n | ||
) |
refocus all of the 3D cameras to the nth markup with the mrml id id
std::string vtkSlicerMarkupsLogic::GetActiveListID | ( | ) |
Utility method to return the id of the active place node. Returns an empty string on failure.
|
virtual |
Reimplemented from vtkSlicerModuleLogic.
double* vtkSlicerMarkupsLogic::GetDefaultMarkupsDisplayNodeColor | ( | ) |
double vtkSlicerMarkupsLogic::GetDefaultMarkupsDisplayNodeGlyphScale | ( | ) |
int vtkSlicerMarkupsLogic::GetDefaultMarkupsDisplayNodeGlyphType | ( | ) |
set/get the default markups display node settings
std::string vtkSlicerMarkupsLogic::GetDefaultMarkupsDisplayNodeGlyphTypeAsString | ( | ) |
double vtkSlicerMarkupsLogic::GetDefaultMarkupsDisplayNodeOpacity | ( | ) |
double* vtkSlicerMarkupsLogic::GetDefaultMarkupsDisplayNodeSelectedColor | ( | ) |
int vtkSlicerMarkupsLogic::GetDefaultMarkupsDisplayNodeSliceProjection | ( | ) |
double* vtkSlicerMarkupsLogic::GetDefaultMarkupsDisplayNodeSliceProjectionColor | ( | ) |
double vtkSlicerMarkupsLogic::GetDefaultMarkupsDisplayNodeSliceProjectionOpacity | ( | ) |
double vtkSlicerMarkupsLogic::GetDefaultMarkupsDisplayNodeTextScale | ( | ) |
std::string vtkSlicerMarkupsLogic::GetSelectionNodeID | ( | ) |
Utility method to return the id of the selection node. Checks the mrml application logic if set, otherwise checks the scene for a singleton selection node. Returns an empty string on failure.
int vtkSlicerMarkupsLogic::GetSliceIntersectionsVisibility | ( | ) |
Inspect all the slice composite nodes in the scene. Return 1 if all have SliceIntersectionVisibility set to true, 0 if all have it set to false, 2 if it's a combination of true and false, -1 on error
|
virtual |
Reimplemented from vtkSlicerModuleLogic.
|
static |
void vtkSlicerMarkupsLogic::JumpSlicesToLocation | ( | double | x, |
double | y, | ||
double | z, | ||
bool | centered, | ||
int | viewGroup = -1 |
||
) |
jump the slice windows to the given coordinate If viewGroup is -1 then all all slice views are updated, otherwise only those views that are in the specified group.
void vtkSlicerMarkupsLogic::JumpSlicesToNthPointInMarkup | ( | const char * | id, |
int | n, | ||
bool | centered = false , |
||
int | viewGroup = -1 |
||
) |
jump the slice windows to the nth markup with the mrml id id
char* vtkSlicerMarkupsLogic::LoadMarkupsFiducials | ( | const char * | fileName, |
const char * | fidsName | ||
) |
Load a markups fiducial list from fileName, return NULL on error, node ID string otherwise. Adds the appropriate storage and display nodes to the scene as well.
bool vtkSlicerMarkupsLogic::MoveNthMarkupToNewListAtIndex | ( | int | n, |
vtkMRMLMarkupsNode * | markupsNode, | ||
vtkMRMLMarkupsNode * | newMarkupsNode, | ||
int | newIndex | ||
) |
utility method to move a markup from one list to another, trying to insert it at the given new index. If the new index is larger than the number of markups in the list, adds it to the end. If new index is smaller than 0, adds it at the beginning. Otherwise inserts at that index.
|
static |
|
protectedvirtual |
Called after a scene is set to the logic and nodes are registered (RegisterNodes()). The scene events to observe are already set in SetMRMLSceneInternal(). By default, ObserveMRMLScene() calls UpdateFromMRMLScene(). Override for a custom behavior.
Reimplemented from vtkMRMLAbstractLogic.
|
protectedvirtual |
If vtkMRMLScene::NodeAddedEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event
Reimplemented from vtkMRMLAbstractLogic.
|
protectedvirtual |
If vtkMRMLScene::NodeRemovedEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event
Reimplemented from vtkMRMLAbstractLogic.
void vtkSlicerMarkupsLogic::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
virtual |
Receives all the events fired by the nodes. To listen to a node, you can add an observer using GetMRMLNodesCallbackCommand() or use the utility macros vtk[SetAndObserve|Observe]MRMLNode[Event]Macro ProcessMRMLNodesEvents calls OnMRMLNodeModified when event is vtkCommand::ModifiedEvent.
Reimplemented from vtkMRMLAbstractLogic.
|
protectedvirtual |
Register MRML Node classes to Scene. Gets called automatically when the MRMLScene is attached to this logic class.
Reimplemented from vtkMRMLAbstractLogic.
void vtkSlicerMarkupsLogic::RenameAllMarkupsFromCurrentFormat | ( | vtkMRMLMarkupsNode * | markupsNode | ) |
Iterate over the markups in the list and reset the markup labels using the current MarkupLabelFormat setting. Try to keep current numbering. Will work if there's a d, g or f in the format string, but precision is not handled.
|
static |
void vtkSlicerMarkupsLogic::SetActiveListID | ( | vtkMRMLMarkupsNode * | markupsNode | ) |
Utility method to set the active place node from the passed markups node. Does not set the interaction mode to place.
void vtkSlicerMarkupsLogic::SetAllMarkupsLocked | ( | vtkMRMLMarkupsNode * | node, |
bool | flag | ||
) |
void vtkSlicerMarkupsLogic::SetAllMarkupsSelected | ( | vtkMRMLMarkupsNode * | node, |
bool | flag | ||
) |
void vtkSlicerMarkupsLogic::SetAllMarkupsVisibility | ( | vtkMRMLMarkupsNode * | node, |
bool | flag | ||
) |
Utility methods to operate on all markups in a markups node.
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeColor | ( | double * | color | ) |
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeColor | ( | double | r, |
double | g, | ||
double | b | ||
) |
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeGlyphScale | ( | double | scale | ) |
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeGlyphType | ( | int | glyphType | ) |
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeGlyphTypeFromString | ( | const char * | glyphType | ) |
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeOpacity | ( | double | opacity | ) |
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeSelectedColor | ( | double * | color | ) |
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeSelectedColor | ( | double | r, |
double | g, | ||
double | b | ||
) |
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeSliceProjection | ( | int | projection | ) |
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeSliceProjectionColor | ( | double * | color | ) |
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeSliceProjectionColor | ( | double | r, |
double | g, | ||
double | b | ||
) |
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeSliceProjectionOpacity | ( | double | opacity | ) |
void vtkSlicerMarkupsLogic::SetDefaultMarkupsDisplayNodeTextScale | ( | double | scale | ) |
void vtkSlicerMarkupsLogic::SetDisplayNodeToDefaults | ( | vtkMRMLMarkupsDisplayNode * | displayNode | ) |
utility method to set up a display node from the defaults
|
protectedvirtual |
Initialize listening to MRML events.
Reimplemented from vtkMRMLAbstractLogic.
void vtkSlicerMarkupsLogic::SetSliceIntersectionsVisibility | ( | bool | flag | ) |
Set the slice intersections visbility on all the slice composite nodes in the scene
bool vtkSlicerMarkupsLogic::StartPlaceMode | ( | bool | persistent, |
vtkMRMLInteractionNode * | interactionNode = NULL |
||
) |
Put the interaction node into place mode, and set the persistence of place mode according to the persistent flag. Return true on successfully going into place mode, false otherwise. By default, the default interaction node is updated.
void vtkSlicerMarkupsLogic::ToggleAllMarkupsLocked | ( | vtkMRMLMarkupsNode * | node | ) |
void vtkSlicerMarkupsLogic::ToggleAllMarkupsSelected | ( | vtkMRMLMarkupsNode * | node | ) |
void vtkSlicerMarkupsLogic::ToggleAllMarkupsVisibility | ( | vtkMRMLMarkupsNode * | node | ) |
|
protectedvirtual |
Called every time the scene has been significantly changed. If the scene BatchProcessState events are observed (in SetMRMLSceneInternal() ), UpdateFromMRMLScene is called after each batch process (Close, Import, Restore...). It is also being called by default when a new scene is set (SetMRMLScene).
Reimplemented from vtkMRMLAbstractLogic.