VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCornerAnnotation Class Reference

text annotation in four corners More...

#include <vtkCornerAnnotation.h>

Inheritance diagram for vtkCornerAnnotation:
[legend]
Collaboration diagram for vtkCornerAnnotation:
[legend]

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. More...
 
vtkCornerAnnotationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Does this prop have some translucent polygonal geometry? More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this actor. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Draw the scalar bar and annotation text to the screen. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *) override
 Draw the scalar bar and annotation text to the screen. More...
 
int RenderOverlay (vtkViewport *viewport) override
 Draw the scalar bar and annotation text to the screen. More...
 
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. More...
 
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. More...
 
virtual void SetMinimumFontSize (int)
 Set/Get the minimum/maximum size font that will be shown. More...
 
virtual int GetMinimumFontSize ()
 Set/Get the minimum/maximum size font that will be shown. More...
 
virtual void SetMaximumFontSize (int)
 Set/Get the minimum/maximum size font that will be shown. More...
 
virtual int GetMaximumFontSize ()
 Set/Get the minimum/maximum size font that will be shown. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void SetText (int i, const char *text)
 Set/Get the text to be displayed for each corner. More...
 
const char * GetText (int i)
 Set/Get the text to be displayed for each corner. More...
 
void ClearAllTexts ()
 Set/Get the text to be displayed for each corner. More...
 
void CopyAllTextsFrom (vtkCornerAnnotation *ca)
 Set/Get the text to be displayed for each corner. More...
 
void SetImageActor (vtkImageActor *)
 Set an image actor to look at for slice information. More...
 
virtual vtkImageActorGetImageActor ()
 Set an image actor to look at for slice information. More...
 
void SetWindowLevel (vtkImageMapToWindowLevelColors *)
 Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes. More...
 
virtual vtkImageMapToWindowLevelColorsGetWindowLevel ()
 Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes. More...
 
virtual void SetLevelShift (double)
 Set the value to shift the level by. More...
 
virtual double GetLevelShift ()
 Set the value to shift the level by. More...
 
virtual void SetLevelScale (double)
 Set the value to scale the level by. More...
 
virtual double GetLevelScale ()
 Set the value to scale the level by. More...
 
virtual void SetTextProperty (vtkTextProperty *p)
 Set/Get the text property of all corners. More...
 
virtual vtkTextPropertyGetTextProperty ()
 Set/Get the text property of all corners. More...
 
virtual void ShowSliceAndImageOn ()
 Even if there is an image actor, should `slice' and `image' be displayed? More...
 
virtual void ShowSliceAndImageOff ()
 Even if there is an image actor, should `slice' and `image' be displayed? More...
 
virtual void SetShowSliceAndImage (vtkTypeBool)
 Even if there is an image actor, should `slice' and `image' be displayed? More...
 
virtual vtkTypeBool GetShowSliceAndImage ()
 Even if there is an image actor, should `slice' and `image' be displayed? More...
 
- 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. More...
 
vtkActor2DNewInstance () const
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Does this prop have some translucent polygonal geometry? More...
 
vtkProperty2DGetProperty ()
 Returns this actor's vtkProperty2D. More...
 
virtual void SetProperty (vtkProperty2D *)
 Set this vtkProp's vtkProperty2D. More...
 
void SetDisplayPosition (int, int)
 Set the Prop2D's position in display coordinates. More...
 
vtkMTimeType GetMTime () override
 Return this objects MTime. More...
 
void GetActors2D (vtkPropCollection *pc) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkActor2D. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this actor. More...
 
virtual vtkCoordinateGetActualPositionCoordinate (void)
 Return the actual vtkCoordinate reference that the mapper should use to position the actor. More...
 
virtual vtkCoordinateGetActualPosition2Coordinate (void)
 Return the actual vtkCoordinate reference that the mapper should use to position the actor. More...
 
int RenderOverlay (vtkViewport *viewport) override
 Support the standard render methods. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Support the standard render methods. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 Support the standard render methods. More...
 
virtual void SetMapper (vtkMapper2D *mapper)
 Set/Get the vtkMapper2D which defines the data to be drawn. More...
 
virtual vtkMapper2DGetMapper ()
 Set/Get the vtkMapper2D which defines the data to be drawn. More...
 
virtual void SetLayerNumber (int)
 Set/Get the layer number in the overlay planes into which to render. More...
 
virtual int GetLayerNumber ()
 Set/Get the layer number in the overlay planes into which to render. More...
 
virtual vtkCoordinateGetPositionCoordinate ()
 Get the PositionCoordinate instance of vtkCoordinate. More...
 
virtual void SetPosition (float x[2])
 Get the PositionCoordinate instance of vtkCoordinate. More...
 
virtual void SetPosition (float x, float y)
 Get the PositionCoordinate instance of vtkCoordinate. More...
 
virtual floatGetPosition ()
 Get the PositionCoordinate instance of vtkCoordinate. More...
 
virtual vtkCoordinateGetPosition2Coordinate ()
 Access the Position2 instance variable. More...
 
virtual void SetPosition2 (float x[2])
 Access the Position2 instance variable. More...
 
virtual void SetPosition2 (float x, float y)
 Access the Position2 instance variable. More...
 
virtual floatGetPosition2 ()
 Access the Position2 instance variable. More...
 
void SetWidth (double w)
 Set/Get the height and width of the Actor2D. More...
 
double GetWidth ()
 Set/Get the height and width of the Actor2D. More...
 
void SetHeight (double h)
 Set/Get the height and width of the Actor2D. More...
 
double GetHeight ()
 Set/Get the height and width of the Actor2D. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void GetActors (vtkPropCollection *)
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
virtual doubleGetBounds ()
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp. More...
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOn ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOff ()
 Set/Get the pickable instance variable. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable. More...
 
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(). More...
 
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(). More...
 
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(). More...
 
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(). More...
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys. More...
 
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. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,. More...
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property. More...
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCornerAnnotationSafeDownCast (vtkObjectBase *o)
 
static vtkCornerAnnotationNew ()
 Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95). More...
 
- Static Public Member Functions inherited from vtkActor2D
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkActor2DSafeDownCast (vtkObjectBase *o)
 
static vtkActor2DNew ()
 Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0. More...
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCornerAnnotation ()
 
 ~vtkCornerAnnotation () override
 
virtual void TextReplace (vtkImageActor *ia, vtkImageMapToWindowLevelColors *wl)
 Search for replaceable tokens and replace. More...
 
virtual void SetTextActorsPosition (int vsize[2])
 Set text actor positions given a viewport size and justification. More...
 
virtual void SetTextActorsJustification ()
 Set text actor positions given a viewport size and justification. More...
 
- Protected Member Functions inherited from vtkActor2D
 vtkActor2D ()
 
 ~vtkActor2D () override
 
- Protected Member Functions inherited from vtkProp
 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double MaximumLineHeight
 
vtkTextPropertyTextProperty
 
vtkImageMapToWindowLevelColorsWindowLevel
 
double LevelShift
 
double LevelScale
 
vtkImageActorImageActor
 
vtkImageActorLastImageActor
 
char * CornerText [NumTextPositions]
 
int FontSize
 
vtkActor2DTextActor [NumTextPositions]
 
vtkTimeStamp BuildTime
 
int LastSize [2]
 
vtkTextMapperTextMapper [NumTextPositions]
 
int MinimumFontSize
 
int MaximumFontSize
 
double LinearFontScaleFactor
 
double NonlinearFontScaleFactor
 
vtkTypeBool ShowSliceAndImage
 
- Protected Attributes inherited from vtkActor2D
vtkMapper2DMapper
 
int LayerNumber
 
vtkProperty2DProperty
 
vtkCoordinatePositionCoordinate
 
vtkCoordinatePosition2Coordinate
 
- 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
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 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. More...
 

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
Tests:
vtkCornerAnnotation (Tests)

Definition at line 50 of file vtkCornerAnnotation.h.

Member Typedef Documentation

Definition at line 53 of file vtkCornerAnnotation.h.

Member Enumeration Documentation

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 125 of file vtkCornerAnnotation.h.

Constructor & Destructor Documentation

vtkCornerAnnotation::vtkCornerAnnotation ( )
protected
vtkCornerAnnotation::~vtkCornerAnnotation ( )
overrideprotected

Member Function Documentation

static vtkTypeBool vtkCornerAnnotation::IsTypeOf ( const char *  type)
static
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.

static vtkCornerAnnotation* vtkCornerAnnotation::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkCornerAnnotation::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkActor2D.

vtkCornerAnnotation* vtkCornerAnnotation::NewInstance ( ) const
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 vtkObject.

static vtkCornerAnnotation* vtkCornerAnnotation::New ( )
static

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

int vtkCornerAnnotation::RenderOpaqueGeometry ( vtkViewport viewport)
overridevirtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkProp.

int vtkCornerAnnotation::RenderTranslucentPolygonalGeometry ( vtkViewport )
inlineoverridevirtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkProp.

Definition at line 67 of file vtkCornerAnnotation.h.

int vtkCornerAnnotation::RenderOverlay ( vtkViewport viewport)
overridevirtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkProp.

vtkTypeBool vtkCornerAnnotation::HasTranslucentPolygonalGeometry ( )
overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

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

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

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.

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.

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.

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.

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)

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)

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)

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)

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 vtkProp.

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

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

See also
TextPosition
const char* vtkCornerAnnotation::GetText ( int  i)

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

See also
TextPosition
void vtkCornerAnnotation::ClearAllTexts ( )

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

See also
TextPosition
void vtkCornerAnnotation::CopyAllTextsFrom ( vtkCornerAnnotation ca)

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

See also
TextPosition
void vtkCornerAnnotation::SetImageActor ( vtkImageActor )

Set an image actor to look at for slice information.

virtual vtkImageActor* vtkCornerAnnotation::GetImageActor ( )
virtual

Set an image actor to look at for slice information.

void vtkCornerAnnotation::SetWindowLevel ( vtkImageMapToWindowLevelColors )

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

virtual vtkImageMapToWindowLevelColors* vtkCornerAnnotation::GetWindowLevel ( )
virtual

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

virtual void vtkCornerAnnotation::SetLevelShift ( double  )
virtual

Set the value to shift the level by.

virtual double vtkCornerAnnotation::GetLevelShift ( )
virtual

Set the value to shift the level by.

virtual void vtkCornerAnnotation::SetLevelScale ( double  )
virtual

Set the value to scale the level by.

virtual double vtkCornerAnnotation::GetLevelScale ( )
virtual

Set the value to scale the level by.

virtual void vtkCornerAnnotation::SetTextProperty ( vtkTextProperty p)
virtual

Set/Get the text property of all corners.

virtual vtkTextProperty* vtkCornerAnnotation::GetTextProperty ( )
virtual

Set/Get the text property of all corners.

virtual void vtkCornerAnnotation::ShowSliceAndImageOn ( )
virtual

Even if there is an image actor, should `slice' and `image' be displayed?

virtual void vtkCornerAnnotation::ShowSliceAndImageOff ( )
virtual

Even if there is an image actor, should `slice' and `image' be displayed?

virtual void vtkCornerAnnotation::SetShowSliceAndImage ( vtkTypeBool  )
virtual

Even if there is an image actor, should `slice' and `image' be displayed?

virtual vtkTypeBool vtkCornerAnnotation::GetShowSliceAndImage ( )
virtual

Even if there is an image actor, should `slice' and `image' be displayed?

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

Search for replaceable tokens and replace.

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

Set text actor positions given a viewport size and justification.

virtual void vtkCornerAnnotation::SetTextActorsJustification ( )
protectedvirtual

Set text actor positions given a viewport size and justification.

Member Data Documentation

const int vtkCornerAnnotation::NumTextPositions = 8
static

Position used to get or set the corner annotation text.

See also
GetText(), SetText()

Definition at line 136 of file vtkCornerAnnotation.h.

double vtkCornerAnnotation::MaximumLineHeight
protected

Definition at line 204 of file vtkCornerAnnotation.h.

vtkTextProperty* vtkCornerAnnotation::TextProperty
protected

Definition at line 206 of file vtkCornerAnnotation.h.

vtkImageMapToWindowLevelColors* vtkCornerAnnotation::WindowLevel
protected

Definition at line 208 of file vtkCornerAnnotation.h.

double vtkCornerAnnotation::LevelShift
protected

Definition at line 209 of file vtkCornerAnnotation.h.

double vtkCornerAnnotation::LevelScale
protected

Definition at line 210 of file vtkCornerAnnotation.h.

vtkImageActor* vtkCornerAnnotation::ImageActor
protected

Definition at line 211 of file vtkCornerAnnotation.h.

vtkImageActor* vtkCornerAnnotation::LastImageActor
protected

Definition at line 212 of file vtkCornerAnnotation.h.

char* vtkCornerAnnotation::CornerText[NumTextPositions]
protected

Definition at line 214 of file vtkCornerAnnotation.h.

int vtkCornerAnnotation::FontSize
protected

Definition at line 216 of file vtkCornerAnnotation.h.

vtkActor2D* vtkCornerAnnotation::TextActor[NumTextPositions]
protected

Definition at line 217 of file vtkCornerAnnotation.h.

vtkTimeStamp vtkCornerAnnotation::BuildTime
protected

Definition at line 218 of file vtkCornerAnnotation.h.

int vtkCornerAnnotation::LastSize[2]
protected

Definition at line 219 of file vtkCornerAnnotation.h.

vtkTextMapper* vtkCornerAnnotation::TextMapper[NumTextPositions]
protected

Definition at line 220 of file vtkCornerAnnotation.h.

int vtkCornerAnnotation::MinimumFontSize
protected

Definition at line 222 of file vtkCornerAnnotation.h.

int vtkCornerAnnotation::MaximumFontSize
protected

Definition at line 223 of file vtkCornerAnnotation.h.

double vtkCornerAnnotation::LinearFontScaleFactor
protected

Definition at line 225 of file vtkCornerAnnotation.h.

double vtkCornerAnnotation::NonlinearFontScaleFactor
protected

Definition at line 226 of file vtkCornerAnnotation.h.

vtkTypeBool vtkCornerAnnotation::ShowSliceAndImage
protected

Definition at line 228 of file vtkCornerAnnotation.h.


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