vtkSlicerAnnotationModuleLogic Class Reference

#include <Modules/Loadable/Annotations/Logic/vtkSlicerAnnotationModuleLogic.h>

Inheritance diagram for vtkSlicerAnnotationModuleLogic:

Collaboration diagram for vtkSlicerAnnotationModuleLogic:

Public Types
enum	Events { RefreshRequestEvent = vtkCommand::UserEvent , HierarchyNodeAddedEvent }
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)

Public Member Functions
void	CreateSnapShot (const char *name, const char *description, int screenshotType, double scaleFactor, vtkImageData *screenshot)
	Create a snapShot.
virtual const char *	GetClassName ()
std::string	GetSnapShotDescription (const char *id)
	Return the description of an existing annotation snapShot.
std::string	GetSnapShotName (const char *id)
	Return the name of an existing annotation snapShot.
double	GetSnapShotScaleFactor (const char *id)
	Return the scaleFactor of an existing annotation snapShot.
vtkImageData *	GetSnapShotScreenshot (const char *id)
	Return the screenshot of an existing annotation snapShot.
int	GetSnapShotScreenshotType (const char *id)
	Return the screenshotType of an existing annotation snapShot.
virtual int	IsA (const char *type)
bool	IsSnapshotNode (const char *id)
	Check if node id corresponds to a snapShot node.
void	ModifySnapShot (std::string id, const char *name, const char *description, int screenshotType, double scaleFactor, vtkImageData *screenshot)
	Modify an existing snapShot.
void	PrintSelf (ostream &os, vtkIndent indent) override
void	RegisterNodes () override
	Register MRML Node classes to Scene. Gets called automatically when the MRMLScene is attached to this logic class.
Public Member Functions inherited from vtkSlicerModuleLogic
virtual vtkSlicerApplicationLogic *	GetApplicationLogic ()
	Get access to overall application state.
virtual vtkMRMLAbstractLogic *	GetModuleLogic (const char *moduleName)
	Convenience method for getting another module's logic from the application logic.
std::string	GetModuleShareDirectory () const
void	PrintSelf (ostream &os, vtkIndent indent) override
void	SetModuleShareDirectory (const std::string &shareDirectory)
Public Member Functions inherited from vtkMRMLAbstractLogic
virtual vtkMRMLApplicationLogic *	GetMRMLApplicationLogic () const
	Get access to overall application state.
vtkMRMLScene *	GetMRMLScene () const
	Return a reference to the current MRML scene.
void	PrintSelf (ostream &os, vtkIndent indent) override
virtual void	SetMRMLApplicationLogic (vtkMRMLApplicationLogic *logic)
void	SetMRMLScene (vtkMRMLScene *newScene)
	Set and observe the MRMLScene.

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkSlicerAnnotationModuleLogic *	New ()
static vtkSlicerAnnotationModuleLogic *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkSlicerModuleLogic
static int	IsTypeOf (const char *type)
static vtkSlicerModuleLogic *	New ()
	The Usual vtk class functions.
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
	vtkSlicerAnnotationModuleLogic ()
	~vtkSlicerAnnotationModuleLogic () override
Protected Member Functions inherited from vtkSlicerModuleLogic
	vtkSlicerModuleLogic ()
	~vtkSlicerModuleLogic () override
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.
int	InvokePendingModifiedEvent ()
void	Modified () override
virtual void	ObserveMRMLScene ()
virtual void	OnMRMLNodeModified (vtkMRMLNode *)
virtual void	OnMRMLSceneEndBatchProcess ()
virtual void	OnMRMLSceneEndClose ()
virtual void	OnMRMLSceneEndImport ()
virtual void	OnMRMLSceneEndRestore ()
virtual void	OnMRMLSceneNew ()
virtual void	OnMRMLSceneNodeAdded (vtkMRMLNode *)
virtual void	OnMRMLSceneNodeRemoved (vtkMRMLNode *)
virtual void	OnMRMLSceneStartBatchProcess ()
virtual void	OnMRMLSceneStartClose ()
virtual void	OnMRMLSceneStartImport ()
virtual void	OnMRMLSceneStartRestore ()
virtual void	ProcessMRMLLogicsEvents (vtkObject *caller, unsigned long event, void *callData)
virtual void	ProcessMRMLNodesEvents (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=nullptr)
void	SetDisableModifiedEvent (bool onOff)
void	SetInMRMLLogicsCallbackFlag (int flag)
void	SetInMRMLNodesCallbackFlag (int flag)
void	SetInMRMLSceneCallbackFlag (int flag)
virtual void	SetMRMLSceneInternal (vtkMRMLScene *newScene)
void	SetProcessingMRMLSceneEvent (int event)
bool	StartModify ()
virtual void	UnobserveMRMLScene ()
virtual void	UpdateFromMRMLScene ()
	vtkMRMLAbstractLogic ()
	~vtkMRMLAbstractLogic () override

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.
static void	MRMLNodesCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
	MRMLNodesCallback is a static function to relay modified events from the nodes.
static void	MRMLSceneCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)

Detailed Description

Definition at line 18 of file vtkSlicerAnnotationModuleLogic.h.

Member Typedef Documentation

Superclass

typedef vtkSlicerModuleLogic vtkSlicerAnnotationModuleLogic::Superclass

Definition at line 27 of file vtkSlicerAnnotationModuleLogic.h.

Member Enumeration Documentation

Events

enum vtkSlicerAnnotationModuleLogic::Events

Enumerator
RefreshRequestEvent
HierarchyNodeAddedEvent

Definition at line 22 of file vtkSlicerAnnotationModuleLogic.h.

Constructor & Destructor Documentation

vtkSlicerAnnotationModuleLogic()

vtkSlicerAnnotationModuleLogic::vtkSlicerAnnotationModuleLogic ( )

protected

~vtkSlicerAnnotationModuleLogic()

vtkSlicerAnnotationModuleLogic::~vtkSlicerAnnotationModuleLogic ( )

overrideprotected

Member Function Documentation

CreateSnapShot()

void vtkSlicerAnnotationModuleLogic::CreateSnapShot	(	const char *	name,
		const char *	description,
		int	screenshotType,
		double	scaleFactor,
		vtkImageData *	screenshot )

Create a snapShot.

GetClassName()

virtual const char * vtkSlicerAnnotationModuleLogic::GetClassName ( )

virtual

Reimplemented from vtkSlicerModuleLogic.

GetSnapShotDescription()

std::string vtkSlicerAnnotationModuleLogic::GetSnapShotDescription

(

const char *

id

)

Return the description of an existing annotation snapShot.

GetSnapShotName()

std::string vtkSlicerAnnotationModuleLogic::GetSnapShotName

(

const char *

id

)

Return the name of an existing annotation snapShot.

GetSnapShotScaleFactor()

double vtkSlicerAnnotationModuleLogic::GetSnapShotScaleFactor

(

const char *

id

)

Return the scaleFactor of an existing annotation snapShot.

GetSnapShotScreenshot()

vtkImageData * vtkSlicerAnnotationModuleLogic::GetSnapShotScreenshot

(

const char *

id

)

Return the screenshot of an existing annotation snapShot.

GetSnapShotScreenshotType()

int vtkSlicerAnnotationModuleLogic::GetSnapShotScreenshotType

(

const char *

id

)

Return the screenshotType of an existing annotation snapShot.

IsA()

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

virtual

Reimplemented from vtkSlicerModuleLogic.

IsSnapshotNode()

bool vtkSlicerAnnotationModuleLogic::IsSnapshotNode

(

const char *

id

)

Check if node id corresponds to a snapShot node.

IsTypeOf()

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

static

ModifySnapShot()

void vtkSlicerAnnotationModuleLogic::ModifySnapShot	(	std::string	id,
		const char *	name,
		const char *	description,
		int	screenshotType,
		double	scaleFactor,
		vtkImageData *	screenshot )

Modify an existing snapShot.

New()

static vtkSlicerAnnotationModuleLogic * vtkSlicerAnnotationModuleLogic::New ( )

static

PrintSelf()

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

override

RegisterNodes()

void vtkSlicerAnnotationModuleLogic::RegisterNodes ( )

overridevirtual

Register MRML Node classes to Scene. Gets called automatically when the MRMLScene is attached to this logic class.

Reimplemented from vtkMRMLAbstractLogic.

SafeDownCast()

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

static

---

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

• Modules/Loadable/Annotations/Logic/vtkSlicerAnnotationModuleLogic.h