Base class for all overlays. More...

#include <mitkOverlay.h>

Inheritance diagram for mitk::Overlay:

Collaboration diagram for mitk::Overlay:

Classes
class	BaseLocalStorage
	Base class for mapper specific rendering ressources. More...

struct	Bounds
	Container for position and size on the display. More...

Public Types
typedef std::map< const BaseRenderer *, PropertyList::Pointer >	MapOfPropertyLists

typedef Overlay	Self

typedef itk::Object	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
void	SetProperty (const std::string &propertyKey, const BaseProperty::Pointer &property, const mitk::BaseRenderer *renderer=nullptr)
	Set the property (instance of BaseProperty) with key propertyKey in the PropertyList of the renderer (if NULL, use BaseRenderer-independent PropertyList). This is set-by-value. More...

void	ReplaceProperty (const std::string &propertyKey, const BaseProperty::Pointer &property, const mitk::BaseRenderer *renderer=nullptr)
	Replace the property (instance of BaseProperty) with key propertyKey in the PropertyList of the renderer (if NULL, use BaseRenderer-independent PropertyList). This is set-by-reference. More...

void	AddProperty (const std::string &propertyKey, const BaseProperty::Pointer &property, const mitk::BaseRenderer *renderer=nullptr, bool overwrite=false)
	Add the property (instance of BaseProperty) if it does not exist (or always if overwrite is true) with key propertyKey in the PropertyList of the renderer (if NULL, use BaseRenderer-independent PropertyList). This is set-by-value. More...

mitk::PropertyList *	GetPropertyList (const mitk::BaseRenderer *renderer=nullptr) const
	Get the PropertyList of the renderer. If renderer is NULL, the BaseRenderer-independent PropertyList of this Overlay is returned. More...

void	ConcatenatePropertyList (PropertyList *pList, bool replace=false)
	Add values from another PropertyList. More...

mitk::BaseProperty *	GetProperty (const std::string &propertyKey, const mitk::BaseRenderer *renderer=nullptr) const
	Get the property (instance of BaseProperty) with key propertyKey from the PropertyList of the renderer, if available there, otherwise use the BaseRenderer-independent PropertyList. More...

template<typename T >
bool	GetProperty (itk::SmartPointer< T > &property, const std::string &propertyKey, const mitk::BaseRenderer *renderer=nullptr) const
	Get the property of type T with key propertyKey from the PropertyList of the renderer, if available there, otherwise use the BaseRenderer-independent PropertyList. More...

template<typename T >
bool	GetProperty (T &property, const std::string &propertyKey, const mitk::BaseRenderer renderer=nullptr) const
	Get the property of type T with key propertyKey from the PropertyList of the renderer, if available there, otherwise use the BaseRenderer-independent PropertyList. More...

template<typename T >
bool	GetPropertyValue (const std::string &propertyKey, T &value, mitk::BaseRenderer *renderer=nullptr) const
	Convenience access method for GenericProperty<T> properties (T being the type of the second parameter) More...

bool	GetBoolProperty (const std::string &propertyKey, bool &boolValue, mitk::BaseRenderer *renderer=nullptr) const
	Convenience access method for bool properties (instances of BoolProperty) More...

bool	GetIntProperty (const std::string &propertyKey, int &intValue, mitk::BaseRenderer *renderer=nullptr) const
	Convenience access method for int properties (instances of IntProperty) More...

bool	GetFloatProperty (const std::string &propertyKey, float &floatValue, mitk::BaseRenderer *renderer=nullptr) const
	Convenience access method for float properties (instances of FloatProperty) More...

bool	GetStringProperty (const std::string &propertyKey, std::string &string, mitk::BaseRenderer *renderer=nullptr) const
	Convenience access method for string properties (instances of StringProperty) More...

void	SetIntProperty (const std::string &propertyKey, int intValue, mitk::BaseRenderer *renderer=nullptr)
	Convenience method for setting int properties (instances of IntProperty) More...

void	SetBoolProperty (const std::string &propertyKey, bool boolValue, mitk::BaseRenderer *renderer=nullptr)
	Convenience method for setting int properties (instances of IntProperty) More...

void	SetFloatProperty (const std::string &propertyKey, float floatValue, mitk::BaseRenderer *renderer=nullptr)
	Convenience method for setting int properties (instances of IntProperty) More...

void	SetStringProperty (const std::string &propertyKey, const std::string &string, mitk::BaseRenderer *renderer=nullptr)
	Convenience method for setting int properties (instances of IntProperty) More...

bool	IsOn (const std::string &propertyKey, mitk::BaseRenderer *renderer, bool defaultIsOn=true) const
	Convenience access method for boolean properties (instances of BoolProperty). Return value is the value of the property. If the property is not found, the value of defaultIsOn is returned. More...

bool	GetName (std::string &nodeName, mitk::BaseRenderer *renderer=nullptr, const std::string &propertyKey="name") const
	Convenience access method for accessing the name of an object (instance of StringProperty with property-key "name") More...

virtual std::string	GetName () const
	Extra convenience access method for accessing the name of an object (instance of StringProperty with property-key "name"). More...

virtual void	SetName (const std::string &name)
	Extra convenience access method to set the name of an object. More...

bool	GetColor (float rgb[], mitk::BaseRenderer *renderer=nullptr, const std::string &propertyKey="color") const
	Convenience access method for color properties (instances of ColorProperty) More...

void	SetColor (const mitk::Color &color, mitk::BaseRenderer *renderer=nullptr, const std::string &propertyKey="color")
	Convenience method for setting color properties (instances of ColorProperty) More...

void	SetColor (float red, float green, float blue, mitk::BaseRenderer *renderer=nullptr, const std::string &propertyKey="color")
	Convenience method for setting color properties (instances of ColorProperty) More...

void	SetColor (const float rgb[], mitk::BaseRenderer *renderer=nullptr, const std::string &propertyKey="color")
	Convenience method for setting color properties (instances of ColorProperty) More...

bool	GetOpacity (float &opacity, mitk::BaseRenderer *renderer, const std::string &propertyKey="opacity") const
	Convenience access method for opacity properties (instances of FloatProperty) More...

void	SetOpacity (float opacity, mitk::BaseRenderer *renderer=nullptr, const std::string &propertyKey="opacity")
	Convenience method for setting opacity properties (instances of FloatProperty) More...

void	SetText (std::string text, mitk::BaseRenderer *renderer=nullptr)

std::string	GetText (mitk::BaseRenderer *renderer=nullptr) const

void	SetFontSize (int fontSize, mitk::BaseRenderer *renderer=nullptr)

int	GetFontSize (mitk::BaseRenderer *renderer=nullptr) const

bool	GetVisibility (bool &visible, mitk::BaseRenderer *renderer, const std::string &propertyKey="visible") const
	Convenience access method for visibility properties (instances of BoolProperty with property-key "visible") More...

bool	IsVisible (mitk::BaseRenderer *renderer, const std::string &propertyKey="visible", bool defaultIsOn=true) const
	Convenience access method for visibility properties (instances of BoolProperty). Return value is the visibility. Default is visible==true, i.e., true is returned even if the property (propertyKey) is not found. More...

void	SetVisibility (bool visible, mitk::BaseRenderer *renderer=nullptr, const std::string &propertyKey="visible")
	Convenience method for setting visibility properties (instances of BoolProperty) More...

virtual void	AddToBaseRenderer (BaseRenderer *renderer)=0
	Adds the overlay to the specified renderer. Update Overlay should be called soon in order to apply all properties. More...

virtual void	AddToRenderer (BaseRenderer renderer, vtkRenderer vtkrenderer)=0
	Adds the overlay to the specified renderer. Update Overlay should be called soon in order to apply all properties. More...

virtual void	RemoveFromBaseRenderer (BaseRenderer *renderer)=0
	Removes the overlay from the specified renderer. It is not visible anymore then. More...

virtual void	RemoveFromRenderer (BaseRenderer renderer, vtkRenderer vtkrenderer)=0
	Removes the overlay from the specified renderer. It is not visible anymore then. More...

virtual void	Update (BaseRenderer *renderer)=0
	Applies all properties and should be called before the rendering procedure. More...

virtual Bounds	GetBoundsOnDisplay (BaseRenderer *renderer) const
	Returns position and size of the overlay on the display. More...

virtual void	SetBoundsOnDisplay (BaseRenderer *renderer, const Bounds &)
	Sets position and size of the overlay on the display. More...

void	SetForceInForeground (bool forceForeground)

bool	IsForceInForeground () const

virtual std::vector< std::string >	GetClassHierarchy () const

virtual const char *	GetClassName () const

Static Public Member Functions
static const char *	GetStaticNameOfClass ()

Protected Member Functions
	Overlay ()
	explicit constructor which disallows implicit conversions More...

virtual	~Overlay ()
	virtual destructor in order to derive from this class More...

Protected Attributes
PropertyList::Pointer	m_PropertyList
	BaseRenderer-independent PropertyList. More...

MapOfPropertyLists	m_MapOfPropertyLists
	Map associating each BaseRenderer with its own PropertyList. More...

itk::TimeStamp	m_DataReferenceChangedTime
	Timestamp of the last change of m_Data. More...

Detailed Description

Base class for all overlays.

This class is to be implemented in order to create overlays which are managed by the OverlayManager and can be placed by a AbstractOverlayLayouter. This class contains an internal Propertylist, and another PropertyList for each BaseRenderer. A property that is specified for a specific renderer always overrides the general internal property of the same name. AddOverlay, RemoveOverlay and UpdateOverlay methods have to be implemented.

Definition at line 34 of file mitkOverlay.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::Overlay::ConstPointer

Definition at line 416 of file mitkOverlay.h.

typedef std::map<const BaseRenderer *, PropertyList::Pointer> mitk::Overlay::MapOfPropertyLists

Definition at line 46 of file mitkOverlay.h.

typedef itk::SmartPointer<Self> mitk::Overlay::Pointer

Definition at line 416 of file mitkOverlay.h.

typedef Overlay mitk::Overlay::Self

Definition at line 416 of file mitkOverlay.h.

typedef itk::Object mitk::Overlay::Superclass

Definition at line 416 of file mitkOverlay.h.

Constructor & Destructor Documentation

mitk::Overlay::Overlay ( )

protected

explicit constructor which disallows implicit conversions

Definition at line 19 of file mitkOverlay.cpp.

References m_PropertyList, mitk::PropertyList::New(), SetName(), SetOpacity(), and SetVisibility().

mitk::Overlay::~Overlay ( )

protectedvirtual

virtual destructor in order to derive from this class

Definition at line 27 of file mitkOverlay.cpp.

Member Function Documentation

void mitk::Overlay::AddProperty	(	const std::string &	propertyKey,
		const BaseProperty::Pointer &	property,
		const mitk::BaseRenderer *	renderer = `nullptr`,
		bool	overwrite = `false`
	)

Add the property (instance of BaseProperty) if it does not exist (or always if overwrite is true) with key propertyKey in the PropertyList of the renderer (if NULL, use BaseRenderer-independent PropertyList). This is set-by-value.

For overwrite == false the property is not changed if it already exists. For overwrite == true the method is identical to SetProperty.

See also: SetProperty; GetProperty; m_PropertyList; m_MapOfPropertyLists

Definition at line 47 of file mitkOverlay.cpp.

virtual void mitk::Overlay::AddToBaseRenderer ( BaseRenderer * renderer )

pure virtual

Adds the overlay to the specified renderer. Update Overlay should be called soon in order to apply all properties.

Implemented in mitk::VtkOverlay.

virtual void mitk::Overlay::AddToRenderer	(	BaseRenderer *	renderer,
		vtkRenderer *	vtkrenderer
	)

pure virtual

Adds the overlay to the specified renderer. Update Overlay should be called soon in order to apply all properties.

Implemented in mitk::VtkOverlay.

void mitk::Overlay::ConcatenatePropertyList	(	PropertyList *	pList,
		bool	replace = `false`
	)

Add values from another PropertyList.

Overwrites values in m_PropertyList only when possible (i.e. when types are compatible). If you want to allow for object type changes (replacing a "visible":BoolProperty with "visible":IntProperty, set the

Parameters

replace.
replace	true: if
pList	contains a property "visible" of type ColorProperty and our m_PropertyList also has a "visible" property of a different type (e.g. BoolProperty), change the type, i.e. replace the objects behind the pointer.

See also: SetProperty; ReplaceProperty; m_PropertyList

Definition at line 58 of file mitkOverlay.cpp.

bool mitk::Overlay::GetBoolProperty	(	const std::string &	propertyKey,
		bool &	boolValue,
		mitk::BaseRenderer *	renderer = `nullptr`
	)		const

Convenience access method for bool properties (instances of BoolProperty)

Returns: true property was found

Definition at line 96 of file mitkOverlay.cpp.

mitk::Overlay::Bounds mitk::Overlay::GetBoundsOnDisplay ( mitk::BaseRenderer * renderer ) const

virtual

Returns position and size of the overlay on the display.

Reimplemented in mitk::TextOverlay2D, and mitk::VtkOverlay2D.

Definition at line 316 of file mitkOverlay.cpp.

References mitk::Overlay::Bounds::Position, and mitk::Overlay::Bounds::Size.

Referenced by mitk::Overlay2DLayouter::PrepareLayout().

virtual std::vector<std::string> mitk::Overlay::GetClassHierarchy ( ) const

inlinevirtual

Reimplemented in mitk::VtkOverlay3D, mitk::VtkOverlay2D, and mitk::VtkOverlay.

Definition at line 416 of file mitkOverlay.h.

virtual const char* mitk::Overlay::GetClassName ( ) const

virtual

Reimplemented in mitk::VtkOverlay3D, mitk::VtkOverlay2D, and mitk::VtkOverlay.

bool mitk::Overlay::GetColor	(	float	rgb[],
		mitk::BaseRenderer *	renderer = `nullptr`,
		const std::string &	propertyKey = `"color"`
	)		const

Convenience access method for color properties (instances of ColorProperty)

Returns: true property was found

Definition at line 226 of file mitkOverlay.cpp.

bool mitk::Overlay::GetFloatProperty	(	const std::string &	propertyKey,
		float &	floatValue,
		mitk::BaseRenderer *	renderer = `nullptr`
	)		const

Convenience access method for float properties (instances of FloatProperty)

Returns: true property was found

Definition at line 116 of file mitkOverlay.cpp.

int mitk::Overlay::GetFontSize ( mitk::BaseRenderer * renderer = nullptr ) const

Definition at line 209 of file mitkOverlay.cpp.

bool mitk::Overlay::GetIntProperty	(	const std::string &	propertyKey,
		int &	intValue,
		mitk::BaseRenderer *	renderer = `nullptr`
	)		const

Convenience access method for int properties (instances of IntProperty)

Returns: true property was found

Definition at line 106 of file mitkOverlay.cpp.

bool mitk::Overlay::GetName	(	std::string &	nodeName,
		mitk::BaseRenderer *	renderer = `nullptr`,
		const std::string &	propertyKey = `"name"`
	)		const

Convenience access method for accessing the name of an object (instance of StringProperty with property-key "name")

Returns: true property was found

Definition at line 187 of file mitkOverlay.cpp.

std::string mitk::Overlay::GetName ( ) const

virtual

Extra convenience access method for accessing the name of an object (instance of StringProperty with property-key "name").

This method does not take the renderer specific propertylists into account, because the name of an object should never be renderer specific.

Returns: a std::string with the name of the object (content of "name" Property). If there is no "name" Property, an empty string will be returned.

Definition at line 174 of file mitkOverlay.cpp.

References mitk::StringProperty::GetValue().

bool mitk::Overlay::GetOpacity	(	float &	opacity,
		mitk::BaseRenderer *	renderer,
		const std::string &	propertyKey = `"opacity"`
	)		const

Convenience access method for opacity properties (instances of FloatProperty)

Returns: true property was found

Definition at line 260 of file mitkOverlay.cpp.

mitk::BaseProperty * mitk::Overlay::GetProperty	(	const std::string &	propertyKey,
		const mitk::BaseRenderer *	renderer = `nullptr`
	)		const

Get the property (instance of BaseProperty) with key propertyKey from the PropertyList of the renderer, if available there, otherwise use the BaseRenderer-independent PropertyList.

If renderer is NULL or the propertyKey cannot be found in the PropertyList specific to renderer or is disabled there, the BaseRenderer-independent PropertyList of this Overlay is queried.

See also: GetPropertyList; m_PropertyList; m_MapOfPropertyLists

Definition at line 63 of file mitkOverlay.cpp.

template<typename T >

bool mitk::Overlay::GetProperty	(	itk::SmartPointer< T > &	property,
		const std::string &	propertyKey,
		const mitk::BaseRenderer *	renderer = `nullptr`
	)		const

inline

Get the property of type T with key propertyKey from the PropertyList of the renderer, if available there, otherwise use the BaseRenderer-independent PropertyList.

If renderer is NULL or the propertyKey cannot be found in the PropertyList specific to renderer or is disabled there, the BaseRenderer-independent PropertyList of this Overlay is queried.

See also: GetPropertyList; m_PropertyList; m_MapOfPropertyLists

Definition at line 165 of file mitkOverlay.h.

template<typename T >

bool mitk::Overlay::GetProperty	(	T *&	property,
		const std::string &	propertyKey,
		const mitk::BaseRenderer *	renderer = `nullptr`
	)		const

inline

Get the property of type T with key propertyKey from the PropertyList of the renderer, if available there, otherwise use the BaseRenderer-independent PropertyList.

If renderer is NULL or the propertyKey cannot be found in the PropertyList specific to renderer or is disabled there, the BaseRenderer-independent PropertyList of this Overlay is queried.

See also: GetPropertyList; m_PropertyList; m_MapOfPropertyLists

Definition at line 185 of file mitkOverlay.h.

mitk::PropertyList * mitk::Overlay::GetPropertyList ( const mitk::BaseRenderer * renderer = nullptr ) const

Get the PropertyList of the renderer. If renderer is NULL, the BaseRenderer-independent PropertyList of this Overlay is returned.

See also: GetProperty; m_PropertyList; m_MapOfPropertyLists

Definition at line 284 of file mitkOverlay.cpp.

References mitk::PropertyList::New().

template<typename T >

bool mitk::Overlay::GetPropertyValue	(	const std::string &	propertyKey,
		T &	value,
		mitk::BaseRenderer *	renderer = `nullptr`
	)		const

inline

Convenience access method for GenericProperty<T> properties (T being the type of the second parameter)

Returns: true property was found

Definition at line 197 of file mitkOverlay.h.

References mitk::GenericProperty< T >::GetValue().

static const char* mitk::Overlay::GetStaticNameOfClass ( )

inlinestatic

Definition at line 416 of file mitkOverlay.h.

bool mitk::Overlay::GetStringProperty	(	const std::string &	propertyKey,
		std::string &	string,
		mitk::BaseRenderer *	renderer = `nullptr`
	)		const

Convenience access method for string properties (instances of StringProperty)

Returns: true property was found

Definition at line 128 of file mitkOverlay.cpp.

std::string mitk::Overlay::GetText ( mitk::BaseRenderer * renderer = nullptr ) const

Definition at line 197 of file mitkOverlay.cpp.

bool mitk::Overlay::GetVisibility	(	bool &	visible,
		mitk::BaseRenderer *	renderer,
		const std::string &	propertyKey = `"visible"`
	)		const

Convenience access method for visibility properties (instances of BoolProperty with property-key "visible")

Returns: true property was found

See also: IsVisible

Definition at line 216 of file mitkOverlay.cpp.

bool mitk::Overlay::IsForceInForeground ( ) const

Definition at line 332 of file mitkOverlay.cpp.

bool mitk::Overlay::IsOn	(	const std::string &	propertyKey,
		mitk::BaseRenderer *	renderer,
		bool	defaultIsOn = `true`
	)		const

inline

Convenience access method for boolean properties (instances of BoolProperty). Return value is the value of the property. If the property is not found, the value of defaultIsOn is returned.

Thus, the return value has a different meaning than in the GetBoolProperty method!

See also: GetBoolProperty

Definition at line 275 of file mitkOverlay.h.

bool mitk::Overlay::IsVisible	(	mitk::BaseRenderer *	renderer,
		const std::string &	propertyKey = `"visible"`,
		bool	defaultIsOn = `true`
	)		const

Convenience access method for visibility properties (instances of BoolProperty). Return value is the visibility. Default is visible==true, i.e., true is returned even if the property (propertyKey) is not found.

Thus, the return value has a different meaning than in the GetVisibility method!

See also: GetVisibility; IsOn

Definition at line 221 of file mitkOverlay.cpp.

virtual void mitk::Overlay::RemoveFromBaseRenderer ( BaseRenderer * renderer )

pure virtual

Removes the overlay from the specified renderer. It is not visible anymore then.

Implemented in mitk::VtkOverlay.

virtual void mitk::Overlay::RemoveFromRenderer	(	BaseRenderer *	renderer,
		vtkRenderer *	vtkrenderer
	)

pure virtual

Removes the overlay from the specified renderer. It is not visible anymore then.

Implemented in mitk::VtkOverlay.

void mitk::Overlay::ReplaceProperty	(	const std::string &	propertyKey,
		const BaseProperty::Pointer &	property,
		const mitk::BaseRenderer *	renderer = `nullptr`
	)

Replace the property (instance of BaseProperty) with key propertyKey in the PropertyList of the renderer (if NULL, use BaseRenderer-independent PropertyList). This is set-by-reference.

If renderer is NULL the property is set in the BaseRenderer-independent PropertyList of this Overlay.

See also: GetProperty; m_PropertyList; m_MapOfPropertyLists

Definition at line 39 of file mitkOverlay.cpp.

void mitk::Overlay::SetBoolProperty	(	const std::string &	propertyKey,
		bool	boolValue,
		mitk::BaseRenderer *	renderer = `nullptr`
	)

Convenience method for setting int properties (instances of IntProperty)

Definition at line 150 of file mitkOverlay.cpp.

References mitk::BoolProperty::New().

Referenced by mitk::TextOverlay2D::TextOverlay2D().

void mitk::Overlay::SetBoundsOnDisplay	(	mitk::BaseRenderer *	renderer,
		const Bounds &
	)

virtual

Sets position and size of the overlay on the display.

Reimplemented in mitk::TextOverlay2D, and mitk::VtkOverlay2D.

Definition at line 323 of file mitkOverlay.cpp.

Referenced by mitk::Overlay2DLayouter::PrepareLayout().

void mitk::Overlay::SetColor	(	const mitk::Color &	color,
		mitk::BaseRenderer *	renderer = `nullptr`,
		const std::string &	propertyKey = `"color"`
	)

Convenience method for setting color properties (instances of ColorProperty)

Definition at line 236 of file mitkOverlay.cpp.

References mitk::ColorProperty::New().

Referenced by mitk::TextOverlay2D::TextOverlay2D(), and mitk::TextOverlay3D::TextOverlay3D().

void mitk::Overlay::SetColor	(	float	red,
		float	green,
		float	blue,
		mitk::BaseRenderer *	renderer = `nullptr`,
		const std::string &	propertyKey = `"color"`
	)

Convenience method for setting color properties (instances of ColorProperty)

Definition at line 243 of file mitkOverlay.cpp.

void mitk::Overlay::SetColor	(	const float	rgb[],
		mitk::BaseRenderer *	renderer = `nullptr`,
		const std::string &	propertyKey = `"color"`
	)

Convenience method for setting color properties (instances of ColorProperty)

Definition at line 253 of file mitkOverlay.cpp.

References mitk::ColorProperty::New().

void mitk::Overlay::SetFloatProperty	(	const std::string &	propertyKey,
		float	floatValue,
		mitk::BaseRenderer *	renderer = `nullptr`
	)

Convenience method for setting int properties (instances of IntProperty)

Definition at line 158 of file mitkOverlay.cpp.

References mitk::FloatProperty::New().

void mitk::Overlay::SetFontSize	(	int	fontSize,
		mitk::BaseRenderer *	renderer = `nullptr`
	)

Definition at line 204 of file mitkOverlay.cpp.

Referenced by mitk::TextOverlay2D::TextOverlay2D(), and mitk::TextOverlay3D::TextOverlay3D().

void mitk::Overlay::SetForceInForeground ( bool forceForeground )

Definition at line 327 of file mitkOverlay.cpp.

void mitk::Overlay::SetIntProperty	(	const std::string &	propertyKey,
		int	intValue,
		mitk::BaseRenderer *	renderer = `nullptr`
	)

Convenience method for setting int properties (instances of IntProperty)

Definition at line 145 of file mitkOverlay.cpp.

References mitk::IntProperty::New().

void mitk::Overlay::SetName ( const std::string & name )

virtual

Extra convenience access method to set the name of an object.

The name will be stored in the non-renderer-specific PropertyList in a StringProperty named "name".

Definition at line 182 of file mitkOverlay.cpp.

Referenced by Overlay().

void mitk::Overlay::SetOpacity	(	float	opacity,
		mitk::BaseRenderer *	renderer = `nullptr`,
		const std::string &	propertyKey = `"opacity"`
	)

Convenience method for setting opacity properties (instances of FloatProperty)

Definition at line 270 of file mitkOverlay.cpp.

References mitk::FloatProperty::New().

Referenced by Overlay().

void mitk::Overlay::SetProperty	(	const std::string &	propertyKey,
		const BaseProperty::Pointer &	property,
		const mitk::BaseRenderer *	renderer = `nullptr`
	)

Set the property (instance of BaseProperty) with key propertyKey in the PropertyList of the renderer (if NULL, use BaseRenderer-independent PropertyList). This is set-by-value.

Warning: Change in semantics since Aug 25th 2006. Check your usage of this method if you do more with properties than just call SetProperty( "key", new SomeProperty("value") ).

See also: GetProperty; m_PropertyList; m_MapOfPropertyLists

Definition at line 31 of file mitkOverlay.cpp.

void mitk::Overlay::SetStringProperty	(	const std::string &	propertyKey,
		const std::string &	string,
		mitk::BaseRenderer *	renderer = `nullptr`
	)

Convenience method for setting int properties (instances of IntProperty)

Definition at line 166 of file mitkOverlay.cpp.

References mitk::StringProperty::New().

Referenced by mitk::TextOverlay2D::TextOverlay2D().

void mitk::Overlay::SetText	(	std::string	text,
		mitk::BaseRenderer *	renderer = `nullptr`
	)

Definition at line 192 of file mitkOverlay.cpp.

Referenced by mitk::TextOverlay2D::TextOverlay2D(), and mitk::TextOverlay3D::TextOverlay3D().

void mitk::Overlay::SetVisibility	(	bool	visible,
		mitk::BaseRenderer *	renderer = `nullptr`,
		const std::string &	propertyKey = `"visible"`
	)

Convenience method for setting visibility properties (instances of BoolProperty)

Parameters

visible	If set to true, the data will be rendered. If false, the render will skip this data.
renderer	Specify a renderer if the visibility shall be specific to a renderer
propertykey	Can be used to specify a user defined name of the visibility propery.

Definition at line 277 of file mitkOverlay.cpp.

References mitk::BoolProperty::New().

Referenced by Overlay().

virtual void mitk::Overlay::Update ( BaseRenderer * renderer )

pure virtual

Applies all properties and should be called before the rendering procedure.

Implemented in mitk::VtkOverlay.

Member Data Documentation

itk::TimeStamp mitk::Overlay::m_DataReferenceChangedTime

protected

Timestamp of the last change of m_Data.

Definition at line 441 of file mitkOverlay.h.

MapOfPropertyLists mitk::Overlay::m_MapOfPropertyLists

mutableprotected

Map associating each BaseRenderer with its own PropertyList.

Definition at line 436 of file mitkOverlay.h.

PropertyList::Pointer mitk::Overlay::m_PropertyList

protected

BaseRenderer-independent PropertyList.

Properties herein can be overwritten specifically for each BaseRenderer by the BaseRenderer-specific properties defined in m_MapOfPropertyLists.

Definition at line 431 of file mitkOverlay.h.

Referenced by Overlay().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation