vtkCornerAnnotation Class Reference

text annotation in four corners More...

#include <vtkCornerAnnotation.h>

Inheritance diagram for vtkCornerAnnotation:

Collaboration diagram for vtkCornerAnnotation:

Public Types
typedef vtkActor2D	Superclass
Public Types inherited from vtkActor2D
typedef vtkProp	Superclass
Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkCornerAnnotation *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry?
void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor.
int	RenderOpaqueGeometry (vtkViewport *viewport) override
	Draw the scalar bar and annotation text to the screen.
int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	Draw the scalar bar and annotation text to the screen.
int	RenderOverlay (vtkViewport *viewport) override
	Draw the scalar bar and annotation text to the screen.
virtual void	SetMaximumLineHeight (double)
	Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor.
virtual double	GetMaximumLineHeight ()
	Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor.
virtual void	SetMinimumFontSize (int)
	Set/Get the minimum/maximum size font that will be shown.
virtual int	GetMinimumFontSize ()
	Set/Get the minimum/maximum size font that will be shown.
virtual void	SetMaximumFontSize (int)
	Set/Get the minimum/maximum size font that will be shown.
virtual int	GetMaximumFontSize ()
	Set/Get the minimum/maximum size font that will be shown.
virtual void	SetLinearFontScaleFactor (double)
	Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap.
virtual double	GetLinearFontScaleFactor ()
	Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap.
virtual void	SetNonlinearFontScaleFactor (double)
	Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap.
virtual double	GetNonlinearFontScaleFactor ()
	Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap.
void	SetText (int i, const char *text)
	Set/Get the text to be displayed for each corner.
const char *	GetText (int i)
	Set/Get the text to be displayed for each corner.
void	ClearAllTexts ()
	Set/Get the text to be displayed for each corner.
void	CopyAllTextsFrom (vtkCornerAnnotation *ca)
	Set/Get the text to be displayed for each corner.
void	SetImageActor (vtkImageActor *)
	Set an image actor to look at for slice information.
virtual vtkImageActor *	GetImageActor ()
	Set an image actor to look at for slice information.
void	SetWindowLevel (vtkImageMapToWindowLevelColors *)
	Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes.
virtual vtkImageMapToWindowLevelColors *	GetWindowLevel ()
	Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes.
virtual void	SetLevelShift (double)
	Set the value to shift the level by.
virtual double	GetLevelShift ()
	Set the value to shift the level by.
virtual void	SetLevelScale (double)
	Set the value to scale the level by.
virtual double	GetLevelScale ()
	Set the value to scale the level by.
virtual void	SetTextProperty (vtkTextProperty *p)
	Set/Get the text property of all corners.
virtual vtkTextProperty *	GetTextProperty ()
	Set/Get the text property of all corners.
virtual void	ShowSliceAndImageOn ()
	Even if there is an image actor, should ‘slice’ and ‘image’ be displayed?
virtual void	ShowSliceAndImageOff ()
	Even if there is an image actor, should ‘slice’ and ‘image’ be displayed?
virtual void	SetShowSliceAndImage (vtkTypeBool)
	Even if there is an image actor, should ‘slice’ and ‘image’ be displayed?
virtual vtkTypeBool	GetShowSliceAndImage ()
	Even if there is an image actor, should ‘slice’ and ‘image’ be displayed?
Public Member Functions inherited from vtkActor2D
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkActor2D *	NewInstance () const
vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry?
vtkProperty2D *	GetProperty ()
	Returns this actor's vtkProperty2D.
virtual void	SetProperty (vtkProperty2D *)
	Set this vtkProp's vtkProperty2D.
void	SetDisplayPosition (int, int)
	Set the Prop2D's position in display coordinates.
vtkMTimeType	GetMTime () override
	Return this objects MTime.
void	GetActors2D (vtkPropCollection *pc) override
	For some exporters and other other operations we must be able to collect all the actors or volumes.
void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkActor2D.
void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor.
virtual vtkCoordinate *	GetActualPositionCoordinate ()
	Return the actual vtkCoordinate reference that the mapper should use to position the actor.
virtual vtkCoordinate *	GetActualPosition2Coordinate ()
	Return the actual vtkCoordinate reference that the mapper should use to position the actor.
virtual void	SetMapper (vtkMapper2D *mapper)
	Set/Get the vtkMapper2D which defines the data to be drawn.
virtual vtkMapper2D *	GetMapper ()
	Set/Get the vtkMapper2D which defines the data to be drawn.
virtual void	SetLayerNumber (int)
	Set/Get the layer number in the overlay planes into which to render.
virtual int	GetLayerNumber ()
	Set/Get the layer number in the overlay planes into which to render.
virtual vtkCoordinate *	GetPositionCoordinate ()
	Get the PositionCoordinate instance of vtkCoordinate.
virtual void	SetPosition (float x[2])
	Get the PositionCoordinate instance of vtkCoordinate.
virtual void	SetPosition (float x, float y)
	Get the PositionCoordinate instance of vtkCoordinate.
virtual float *	GetPosition ()
	Get the PositionCoordinate instance of vtkCoordinate.
virtual vtkCoordinate *	GetPosition2Coordinate ()
	Access the Position2 instance variable.
virtual void	SetPosition2 (float x[2])
	Access the Position2 instance variable.
virtual void	SetPosition2 (float x, float y)
	Access the Position2 instance variable.
virtual float *	GetPosition2 ()
	Access the Position2 instance variable.
void	SetWidth (double w)
	Set/Get the height and width of the Actor2D.
double	GetWidth ()
	Set/Get the height and width of the Actor2D.
void	SetHeight (double h)
	Set/Get the height and width of the Actor2D.
double	GetHeight ()
	Set/Get the height and width of the Actor2D.
Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkProp *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.
virtual void	GetActors2D (vtkPropCollection *)
virtual void	GetVolumes (vtkPropCollection *)
virtual void	Pick ()
	Method fires PickEvent if the prop is picked.
virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.
virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.
virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
virtual vtkMatrix4x4 *	GetMatrix ()
virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.
virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	RenderVolumetricGeometry (vtkViewport *)
virtual int	RenderOverlay (vtkViewport *)
virtual bool	RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.
virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.
virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.
virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail.
virtual double	GetEstimatedRenderTime ()
virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.
virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.
virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.
void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.
virtual double	GetRenderTimeMultiplier ()
virtual void	BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.
virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.
virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers
virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.
virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.
virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.
virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.
virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.
virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.
virtual void	PickableOn ()
	Set/Get the pickable instance variable.
virtual void	PickableOff ()
	Set/Get the pickable instance variable.
virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.
virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.
virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.
virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.
virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.
virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.
virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor.
virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
virtual int	GetNumberOfConsumers ()
	Get the number of consumers.
void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.
int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.
virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.
virtual bool	IsRenderingTranslucentPolygonalGeometry ()
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkCornerAnnotation *	SafeDownCast (vtkObjectBase *o)
static vtkCornerAnnotation *	New ()
	Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).
Static Public Member Functions inherited from vtkActor2D
static vtkTypeBool	IsTypeOf (const char *type)
static vtkActor2D *	SafeDownCast (vtkObjectBase *o)
static vtkActor2D *	New ()
	Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0.
Static Public Member Functions inherited from vtkProp
static vtkTypeBool	IsTypeOf (const char *type)
static vtkProp *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.
static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkCornerAnnotation ()
	~vtkCornerAnnotation () override
virtual void	TextReplace (vtkImageActor *ia, vtkImageMapToWindowLevelColors *wl)
	Search for replaceable tokens and replace.
virtual void	SetTextActorsPosition (const int vsize[2])
	Set text actor positions given a viewport size and justification.
virtual void	SetTextActorsJustification ()
	Set text actor positions given a viewport size and justification.
Protected Member Functions inherited from vtkActor2D
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkActor2D ()
	~vtkActor2D () override
Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkProp ()
	~vtkProp () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	MaximumLineHeight
vtkTextProperty *	TextProperty
vtkImageMapToWindowLevelColors *	WindowLevel
double	LevelShift
double	LevelScale
vtkImageActor *	ImageActor
vtkImageActor *	LastImageActor
char *	CornerText [NumTextPositions]
int	FontSize
vtkActor2D *	TextActor [NumTextPositions]
vtkTimeStamp	BuildTime
int	LastSize [2]
vtkTextMapper *	TextMapper [NumTextPositions]
int	MinimumFontSize
int	MaximumFontSize
double	LinearFontScaleFactor
double	NonlinearFontScaleFactor
vtkTypeBool	ShowSliceAndImage
Protected Attributes inherited from vtkActor2D
vtkMapper2D *	Mapper
int	LayerNumber
vtkProperty2D *	Property
vtkCoordinate *	PositionCoordinate
vtkCoordinate *	Position2Coordinate
Protected Attributes inherited from vtkProp
vtkTypeBool	Visibility
vtkTypeBool	Pickable
vtkTypeBool	Dragable
bool	UseBounds
double	AllocatedRenderTime
double	EstimatedRenderTime
double	SavedEstimatedRenderTime
double	RenderTimeMultiplier
int	NumberOfConsumers
vtkObject **	Consumers
vtkAssemblyPaths *	Paths
vtkInformation *	PropertyKeys
vtkShaderProperty *	ShaderProperty
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers
enum	TextPosition {   LowerLeft = 0 , LowerRight , UpperLeft , UpperRight ,   LowerEdge , RightEdge , LeftEdge , UpperEdge }
	Position used to get or set the corner annotation text. More...
static const int	NumTextPositions = 8
	Position used to get or set the corner annotation text.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

text annotation in four corners

This is an annotation object that manages four text actors / mappers to provide annotation in the four corners of a viewport

Special input text::

• <image> : will be replaced with slice number (relative number)
• <slice> : will be replaced with slice number (relative number)
• <image_and_max> : will be replaced with slice number and slice max (relative)
• <slice_and_max> : will be replaced with slice number and slice max (relative)
• <slice_pos> : will be replaced by the position of the current slice
• <window> : will be replaced with window value
• <level> : will be replaced with level value
• <window_level> : will be replaced with window and level value

See also

vtkActor2D vtkTextMapper

Online Examples:

PickPixel

PickPixel2

CornerAnnotation

Tests:

vtkCornerAnnotation (Tests)

Definition at line 79 of file vtkCornerAnnotation.h.

Member Typedef Documentation

Superclass

typedef vtkActor2D vtkCornerAnnotation::Superclass

Definition at line 82 of file vtkCornerAnnotation.h.

Member Enumeration Documentation

TextPosition

enum vtkCornerAnnotation::TextPosition

Position used to get or set the corner annotation text.

See also

GetText(), SetText()

Enumerator
LowerLeft	Uses the lower left corner.
LowerRight	Uses the lower right corner.
UpperLeft	Uses the upper left corner.
UpperRight	Uses the upper right corner.
LowerEdge	Uses the lower edge center.
RightEdge	Uses the right edge center.
LeftEdge	Uses the left edge center.
UpperEdge	Uses the upper edge center.

Definition at line 154 of file vtkCornerAnnotation.h.

Constructor & Destructor Documentation

vtkCornerAnnotation()

vtkCornerAnnotation::vtkCornerAnnotation ( )

protected

~vtkCornerAnnotation()

vtkCornerAnnotation::~vtkCornerAnnotation ( )

overrideprotected

Member Function Documentation

IsTypeOf()

static vtkTypeBool vtkCornerAnnotation::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkCornerAnnotation::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkActor2D.

SafeDownCast()

static vtkCornerAnnotation * vtkCornerAnnotation::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkCornerAnnotation::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkActor2D.

NewInstance()

vtkCornerAnnotation * vtkCornerAnnotation::NewInstance

(

)

const

PrintSelf()

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkActor2D.

New()

static vtkCornerAnnotation * vtkCornerAnnotation::New ( )

static

Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).

RenderOpaqueGeometry()

int vtkCornerAnnotation::RenderOpaqueGeometry ( vtkViewport *  viewport )

overridevirtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkActor2D.

RenderTranslucentPolygonalGeometry()

int vtkCornerAnnotation::RenderTranslucentPolygonalGeometry ( vtkViewport *  )

inlineoverridevirtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkActor2D.

Definition at line 96 of file vtkCornerAnnotation.h.

RenderOverlay()

int vtkCornerAnnotation::RenderOverlay ( vtkViewport *  viewport )

overridevirtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkActor2D.

HasTranslucentPolygonalGeometry()

vtkTypeBool vtkCornerAnnotation::HasTranslucentPolygonalGeometry ( )

overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkActor2D.

SetMaximumLineHeight()

virtual void vtkCornerAnnotation::SetMaximumLineHeight ( double  )

virtual

Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor.

Defaults to 1.0

GetMaximumLineHeight()

virtual double vtkCornerAnnotation::GetMaximumLineHeight ( )

virtual

Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor.

Defaults to 1.0

SetMinimumFontSize()

virtual void vtkCornerAnnotation::SetMinimumFontSize ( int  )

virtual

Set/Get the minimum/maximum size font that will be shown.

If the font drops below the minimum size it will not be rendered.

GetMinimumFontSize()

virtual int vtkCornerAnnotation::GetMinimumFontSize ( )

virtual

Set/Get the minimum/maximum size font that will be shown.

If the font drops below the minimum size it will not be rendered.

SetMaximumFontSize()

virtual void vtkCornerAnnotation::SetMaximumFontSize ( int  )

virtual

Set/Get the minimum/maximum size font that will be shown.

If the font drops below the minimum size it will not be rendered.

GetMaximumFontSize()

virtual int vtkCornerAnnotation::GetMaximumFontSize ( )

virtual

Set/Get the minimum/maximum size font that will be shown.

If the font drops below the minimum size it will not be rendered.

SetLinearFontScaleFactor()

virtual void vtkCornerAnnotation::SetLinearFontScaleFactor ( double  )

virtual

Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap.

This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)

GetLinearFontScaleFactor()

virtual double vtkCornerAnnotation::GetLinearFontScaleFactor ( )

virtual

Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap.

This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)

SetNonlinearFontScaleFactor()

virtual void vtkCornerAnnotation::SetNonlinearFontScaleFactor ( double  )

virtual

Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap.

This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)

GetNonlinearFontScaleFactor()

virtual double vtkCornerAnnotation::GetNonlinearFontScaleFactor ( )

virtual

Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap.

This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)

ReleaseGraphicsResources()

void vtkCornerAnnotation::ReleaseGraphicsResources ( vtkWindow *  )

overridevirtual

Release any graphics resources that are being consumed by this actor.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkActor2D.

SetText()

void vtkCornerAnnotation::SetText	(	int	i,
		const char *	text
	)

Set/Get the text to be displayed for each corner.

See also

TextPosition

GetText()

const char * vtkCornerAnnotation::GetText

(

int

i

)

Set/Get the text to be displayed for each corner.

See also

TextPosition

ClearAllTexts()

void vtkCornerAnnotation::ClearAllTexts

(

)

Set/Get the text to be displayed for each corner.

See also

TextPosition

CopyAllTextsFrom()

void vtkCornerAnnotation::CopyAllTextsFrom

(

vtkCornerAnnotation *

ca

)

Set/Get the text to be displayed for each corner.

See also

TextPosition

SetImageActor()

void vtkCornerAnnotation::SetImageActor

(

vtkImageActor *

)

Set an image actor to look at for slice information.

GetImageActor()

virtual vtkImageActor * vtkCornerAnnotation::GetImageActor ( )

virtual

Set an image actor to look at for slice information.

SetWindowLevel()

void vtkCornerAnnotation::SetWindowLevel

(

vtkImageMapToWindowLevelColors *

)

Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes.

GetWindowLevel()

virtual vtkImageMapToWindowLevelColors * vtkCornerAnnotation::GetWindowLevel ( )

virtual

Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes.

SetLevelShift()

virtual void vtkCornerAnnotation::SetLevelShift ( double  )

virtual

Set the value to shift the level by.

GetLevelShift()

virtual double vtkCornerAnnotation::GetLevelShift ( )

virtual

Set the value to shift the level by.

SetLevelScale()

virtual void vtkCornerAnnotation::SetLevelScale ( double  )

virtual

Set the value to scale the level by.

GetLevelScale()

virtual double vtkCornerAnnotation::GetLevelScale ( )

virtual

Set the value to scale the level by.

SetTextProperty()

virtual void vtkCornerAnnotation::SetTextProperty ( vtkTextProperty *  p )

virtual

Set/Get the text property of all corners.

GetTextProperty()

virtual vtkTextProperty * vtkCornerAnnotation::GetTextProperty ( )

virtual

Set/Get the text property of all corners.

ShowSliceAndImageOn()

virtual void vtkCornerAnnotation::ShowSliceAndImageOn ( )

virtual

Even if there is an image actor, should ‘slice’ and ‘image’ be displayed?

ShowSliceAndImageOff()

virtual void vtkCornerAnnotation::ShowSliceAndImageOff ( )

virtual

Even if there is an image actor, should ‘slice’ and ‘image’ be displayed?

SetShowSliceAndImage()

virtual void vtkCornerAnnotation::SetShowSliceAndImage ( vtkTypeBool  )

virtual

Even if there is an image actor, should ‘slice’ and ‘image’ be displayed?

GetShowSliceAndImage()

virtual vtkTypeBool vtkCornerAnnotation::GetShowSliceAndImage ( )

virtual

Even if there is an image actor, should ‘slice’ and ‘image’ be displayed?

TextReplace()

virtual void vtkCornerAnnotation::TextReplace ( vtkImageActor *  ia, vtkImageMapToWindowLevelColors *  wl  )

protectedvirtual

Search for replaceable tokens and replace.

SetTextActorsPosition()

virtual void vtkCornerAnnotation::SetTextActorsPosition ( const int  vsize[2] )

protectedvirtual

Set text actor positions given a viewport size and justification.

SetTextActorsJustification()

virtual void vtkCornerAnnotation::SetTextActorsJustification ( )

protectedvirtual

Set text actor positions given a viewport size and justification.

Member Data Documentation

NumTextPositions

const int vtkCornerAnnotation::NumTextPositions = 8

static

Position used to get or set the corner annotation text.

See also

GetText(), SetText()

Definition at line 165 of file vtkCornerAnnotation.h.

MaximumLineHeight

double vtkCornerAnnotation::MaximumLineHeight

protected

Definition at line 233 of file vtkCornerAnnotation.h.

TextProperty

vtkTextProperty* vtkCornerAnnotation::TextProperty

protected

Definition at line 235 of file vtkCornerAnnotation.h.

WindowLevel

vtkImageMapToWindowLevelColors* vtkCornerAnnotation::WindowLevel

protected

Definition at line 237 of file vtkCornerAnnotation.h.

LevelShift

double vtkCornerAnnotation::LevelShift

protected

Definition at line 238 of file vtkCornerAnnotation.h.

LevelScale

double vtkCornerAnnotation::LevelScale

protected

Definition at line 239 of file vtkCornerAnnotation.h.

ImageActor

vtkImageActor* vtkCornerAnnotation::ImageActor

protected

Definition at line 240 of file vtkCornerAnnotation.h.

LastImageActor

vtkImageActor* vtkCornerAnnotation::LastImageActor

protected

Definition at line 241 of file vtkCornerAnnotation.h.

CornerText

char* vtkCornerAnnotation::CornerText[NumTextPositions]

protected

Definition at line 243 of file vtkCornerAnnotation.h.

FontSize

int vtkCornerAnnotation::FontSize

protected

Definition at line 245 of file vtkCornerAnnotation.h.

TextActor

vtkActor2D* vtkCornerAnnotation::TextActor[NumTextPositions]

protected

Definition at line 246 of file vtkCornerAnnotation.h.

BuildTime

vtkTimeStamp vtkCornerAnnotation::BuildTime

protected

Definition at line 247 of file vtkCornerAnnotation.h.

LastSize

int vtkCornerAnnotation::LastSize[2]

protected

Definition at line 248 of file vtkCornerAnnotation.h.

TextMapper

vtkTextMapper* vtkCornerAnnotation::TextMapper[NumTextPositions]

protected

Definition at line 249 of file vtkCornerAnnotation.h.

MinimumFontSize

int vtkCornerAnnotation::MinimumFontSize

protected

Definition at line 251 of file vtkCornerAnnotation.h.

MaximumFontSize

int vtkCornerAnnotation::MaximumFontSize

protected

Definition at line 252 of file vtkCornerAnnotation.h.

LinearFontScaleFactor

double vtkCornerAnnotation::LinearFontScaleFactor

protected

Definition at line 254 of file vtkCornerAnnotation.h.

NonlinearFontScaleFactor

double vtkCornerAnnotation::NonlinearFontScaleFactor

protected

Definition at line 255 of file vtkCornerAnnotation.h.

ShowSliceAndImage

vtkTypeBool vtkCornerAnnotation::ShowSliceAndImage

protected

Definition at line 257 of file vtkCornerAnnotation.h.

---

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

• Rendering/Annotation/vtkCornerAnnotation.h