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

Clipped, transformed area with axes for context items. More...

#include <vtkContextArea.h>

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

Public Types

enum  DrawAreaResizeBehaviorType { DARB_Expand, DARB_FixedAspect, DARB_FixedRect, DARB_FixedMargins }
 
typedef vtkTuple< int, 4 > Margins
 
typedef vtkAbstractContextItem Superclass
 
- Public Types inherited from vtkAbstractContextItem
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...
 
vtkContextAreaNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkAxisGetAxis (vtkAxis::Location location)
 Get the vtkAxis associated with the specified location. More...
 
vtkAbstractContextItemGetDrawAreaItem ()
 Returns the vtkAbstractContextItem that will draw in the clipped, transformed space. More...
 
bool Paint (vtkContext2D *painter) override
 Paint event for the item, called whenever the item needs to be drawn. More...
 
virtual vtkRecti GetGeometry ()
 The rect defining the pixel location and size of the entire vtkContextArea, including axis labels, title, etc. More...
 
virtual void SetGeometry (vtkRecti)
 
virtual vtkRectd GetDrawAreaBounds ()
 The data bounds of the clipped and transformed area inside of the axes. More...
 
virtual void SetDrawAreaBounds (vtkRectd)
 
virtual DrawAreaResizeBehaviorType GetDrawAreaResizeBehavior ()
 Set the resize behavior for the draw area: More...
 
virtual void SetDrawAreaResizeBehavior (DrawAreaResizeBehaviorType)
 
virtual float GetFixedAspect ()
 The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect. More...
 
virtual void SetFixedAspect (float aspect)
 
virtual vtkRecti GetFixedRect ()
 The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect. More...
 
virtual void SetFixedRect (vtkRecti rect)
 
virtual void SetFixedRect (int x, int y, int width, int height)
 
virtual const MarginsGetFixedMargins ()
 The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins. More...
 
virtual void GetFixedMarginsArray (int margins[4])
 
virtual const int * GetFixedMarginsArray ()
 
virtual void SetFixedMargins (Margins margins)
 
virtual void SetFixedMargins (int margins[4])
 
virtual void SetFixedMargins (int left, int right, int bottom, int top)
 
virtual bool GetFillViewport ()
 If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call. More...
 
virtual void SetFillViewport (bool)
 
virtual void FillViewportOn ()
 
virtual void FillViewportOff ()
 
virtual void SetShowGrid (bool show)
 Turn on/off grid visibility. More...
 
virtual bool GetShowGrid ()
 
virtual void ShowGridOn ()
 
virtual void ShowGridOff ()
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Update ()
 Perform any updates to the item that may be necessary before rendering. More...
 
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered. More...
 
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item. More...
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index. More...
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex. More...
 
vtkIdType GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack. More...
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling. More...
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling. More...
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 Return true if the supplied x, y coordinate is inside the item. More...
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse. More...
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event. More...
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 Mouse move event. More...
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event. More...
 
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
 Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items. More...
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release event. More...
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 Mouse button double click event. More...
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event. More...
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event. More...
 
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene. More...
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene. More...
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item. More...
 
vtkAbstractContextItemGetParent ()
 Get the parent item. More...
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system. More...
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system. More...
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system. More...
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system. More...
 
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn). More...
 
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn). More...
 
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events). More...
 
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events). More...
 
- 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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContextAreaSafeDownCast (vtkObjectBase *o)
 
static vtkContextAreaNew ()
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 vtkContextArea ()
 
 ~vtkContextArea () override
 
void LayoutAxes (vtkContext2D *painter)
 Sync the Axes locations with Geometry, and update the DrawAreaGeometry to account for Axes size (margins). More...
 
virtual void SetAxisRange (vtkRectd const &data)
 
virtual void ComputeViewTransform ()
 
vtkRecti ComputeDrawAreaGeometry (vtkContext2D *painter)
 Return the draw area's geometry. More...
 
vtkRecti ComputeExpandedDrawAreaGeometry (vtkContext2D *painter)
 Working implementations for ComputeDrawAreaGeometry. More...
 
vtkRecti ComputeFixedAspectDrawAreaGeometry (vtkContext2D *painter)
 
vtkRecti ComputeFixedRectDrawAreaGeometry (vtkContext2D *painter)
 
vtkRecti ComputeFixedMarginsDrawAreaGeometry (vtkContext2D *painter)
 
void UpdateDrawArea ()
 Set the transform to map DrawAreaBounds to DrawAreaGeometry. More...
 
virtual void InitializeDrawArea ()
 Initialize the drawing area's item hierarchy. More...
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () 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 ()
 
- 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

vtkTuple< vtkAxis *, 4 > Axes
 vtkAxis objects that surround the draw area, indexed by vtkAxis::Location. More...
 
vtkNew< vtkPlotGridGrid
 The vtkPlotGrid that renders a grid atop the data in the draw area. More...
 
vtkNew< vtkContextClipClip
 The context item that clips rendered data. More...
 
vtkNew< vtkContextTransformTransform
 The context item that clips rendered data. More...
 
vtkRecti Geometry
 The rect defining the pixel location and size of the entire vtkContextArea, including axis label, title, etc. More...
 
vtkRectd DrawAreaBounds
 The data bounds of the clipped and transformed area inside of the axes. More...
 
vtkRecti DrawAreaGeometry
 The rect defining the pixel location and size of the clipped and transformed area inside the axes. More...
 
DrawAreaResizeBehaviorType DrawAreaResizeBehavior
 Controls how the draw area size is determined. More...
 
float FixedAspect
 The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect. More...
 
vtkRecti FixedRect
 The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect. More...
 
Margins FixedMargins
 The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins. More...
 
bool FillViewport
 If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call. More...
 
vtkNew< vtkAxisTopAxis
 
vtkNew< vtkAxisBottomAxis
 
vtkNew< vtkAxisLeftAxis
 
vtkNew< vtkAxisRightAxis
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 Point to the scene the item is on - can be null. More...
 
vtkAbstractContextItemParent
 Point to the parent item - can be null. More...
 
vtkContextScenePrivateChildren
 This structure provides a list of children, along with convenience functions to paint the children etc. More...
 
bool Visible
 Store the visibility of the item (default is true). More...
 
bool Interactive
 Store whether the item should respond to interactions (default is true). More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Clipped, transformed area with axes for context items.

vtkContextArea provides an clipped drawing area surrounded by four axes. The drawing area is transformed to map the 2D area described by DrawAreaBounds into pixel coordinates. DrawAreaBounds is also used to configure the axes. Item to be rendered in the draw area should be added to the context item returned by GetDrawAreaItem().

The size and shape of the draw area is configured by the following member variables:

Definition at line 54 of file vtkContextArea.h.

Member Typedef Documentation

◆ Margins

Definition at line 57 of file vtkContextArea.h.

◆ Superclass

Definition at line 58 of file vtkContextArea.h.

Member Enumeration Documentation

◆ DrawAreaResizeBehaviorType

Enumerator
DARB_Expand 
DARB_FixedAspect 
DARB_FixedRect 
DARB_FixedMargins 

Definition at line 98 of file vtkContextArea.h.

Constructor & Destructor Documentation

◆ vtkContextArea()

vtkContextArea::vtkContextArea ( )
protected

◆ ~vtkContextArea()

vtkContextArea::~vtkContextArea ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkContextArea::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 vtkAbstractContextItem.

Reimplemented in vtkInteractiveArea.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkContextArea::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkInteractiveArea.

◆ NewInstance()

vtkContextArea* vtkContextArea::NewInstance ( ) const

◆ PrintSelf()

void vtkContextArea::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 vtkObjectBase.

Reimplemented in vtkInteractiveArea.

◆ New()

static vtkContextArea* vtkContextArea::New ( )
static

◆ GetAxis()

vtkAxis* vtkContextArea::GetAxis ( vtkAxis::Location  location)

Get the vtkAxis associated with the specified location.

◆ GetDrawAreaItem()

vtkAbstractContextItem* vtkContextArea::GetDrawAreaItem ( )

Returns the vtkAbstractContextItem that will draw in the clipped, transformed space.

This is the item to add children for.

◆ Paint()

bool vtkContextArea::Paint ( vtkContext2D painter)
overridevirtual

Paint event for the item, called whenever the item needs to be drawn.

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkInteractiveArea.

◆ GetGeometry()

virtual vtkRecti vtkContextArea::GetGeometry ( )
virtual

The rect defining the pixel location and size of the entire vtkContextArea, including axis labels, title, etc.

Note that this will be updated to the window geometry if FillWindow is true.

◆ SetGeometry()

virtual void vtkContextArea::SetGeometry ( vtkRecti  )
virtual

◆ GetDrawAreaBounds()

virtual vtkRectd vtkContextArea::GetDrawAreaBounds ( )
virtual

The data bounds of the clipped and transformed area inside of the axes.

This is used to configure the axes labels and setup the transform.

◆ SetDrawAreaBounds()

virtual void vtkContextArea::SetDrawAreaBounds ( vtkRectd  )
virtual

◆ GetDrawAreaResizeBehavior()

virtual DrawAreaResizeBehaviorType vtkContextArea::GetDrawAreaResizeBehavior ( )
virtual

Set the resize behavior for the draw area:

  • Expand: The default behavior. The draw area will automatically resize to take up as much of Geometry as possible. Margin sizes are minimized based on the space required for axis labels/tick marks.
  • FixedAspect: Same as Expand, but a fixed aspect ratio is enforced. See SetFixedAspect.
  • FixedRect: Draw area is always constrained to a fixed rectangle. See SetFixedRect.
  • FixMargins: The draw area expands to fill Geometry, but margins (axis labels, etc) are fixed, rather than dynamically sized. See SetFixedMargins.

◆ SetDrawAreaResizeBehavior()

virtual void vtkContextArea::SetDrawAreaResizeBehavior ( DrawAreaResizeBehaviorType  )
virtual

◆ GetFixedAspect()

virtual float vtkContextArea::GetFixedAspect ( )
virtual

The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect.

Defined as width/height. Default is 1. Setting the aspect ratio will also set DrawAreaResizeBehavior to FixedAspect.

◆ SetFixedAspect()

virtual void vtkContextArea::SetFixedAspect ( float  aspect)
virtual

◆ GetFixedRect()

virtual vtkRecti vtkContextArea::GetFixedRect ( )
virtual

The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect.

Units are in pixels, default is 300x300+0+0. Setting the fixed rect will also set DrawAreaResizeBehavior to FixedRect.

◆ SetFixedRect() [1/2]

virtual void vtkContextArea::SetFixedRect ( vtkRecti  rect)
virtual

◆ SetFixedRect() [2/2]

virtual void vtkContextArea::SetFixedRect ( int  x,
int  y,
int  width,
int  height 
)
virtual

◆ GetFixedMargins()

virtual const Margins& vtkContextArea::GetFixedMargins ( )
inlinevirtual

The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.

Units are in pixels, default is { 0, 0, 0, 0 }. Setting the fixed margins will also set DrawAreaResizeBehavior to FixedMargins.

Definition at line 154 of file vtkContextArea.h.

◆ GetFixedMarginsArray() [1/2]

virtual void vtkContextArea::GetFixedMarginsArray ( int  margins[4])
virtual

◆ GetFixedMarginsArray() [2/2]

virtual const int* vtkContextArea::GetFixedMarginsArray ( )
virtual

◆ SetFixedMargins() [1/3]

virtual void vtkContextArea::SetFixedMargins ( Margins  margins)
virtual

◆ SetFixedMargins() [2/3]

virtual void vtkContextArea::SetFixedMargins ( int  margins[4])
virtual

◆ SetFixedMargins() [3/3]

virtual void vtkContextArea::SetFixedMargins ( int  left,
int  right,
int  bottom,
int  top 
)
virtual

◆ GetFillViewport()

virtual bool vtkContextArea::GetFillViewport ( )
virtual

If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call.

vpSize is vtkContextDevice2D::GetViewportSize. Default is true.

◆ SetFillViewport()

virtual void vtkContextArea::SetFillViewport ( bool  )
virtual

◆ FillViewportOn()

virtual void vtkContextArea::FillViewportOn ( )
virtual

◆ FillViewportOff()

virtual void vtkContextArea::FillViewportOff ( )
virtual

◆ SetShowGrid()

virtual void vtkContextArea::SetShowGrid ( bool  show)
virtual

Turn on/off grid visibility.

◆ GetShowGrid()

virtual bool vtkContextArea::GetShowGrid ( )
virtual

◆ ShowGridOn()

virtual void vtkContextArea::ShowGridOn ( )
inlinevirtual

Definition at line 179 of file vtkContextArea.h.

◆ ShowGridOff()

virtual void vtkContextArea::ShowGridOff ( )
inlinevirtual

Definition at line 180 of file vtkContextArea.h.

◆ LayoutAxes()

void vtkContextArea::LayoutAxes ( vtkContext2D painter)
protected

Sync the Axes locations with Geometry, and update the DrawAreaGeometry to account for Axes size (margins).

Must be called while the painter is active.

◆ SetAxisRange()

virtual void vtkContextArea::SetAxisRange ( vtkRectd const &  data)
protectedvirtual

Reimplemented in vtkInteractiveArea.

◆ ComputeViewTransform()

virtual void vtkContextArea::ComputeViewTransform ( )
protectedvirtual

◆ ComputeDrawAreaGeometry()

vtkRecti vtkContextArea::ComputeDrawAreaGeometry ( vtkContext2D painter)
protected

Return the draw area's geometry.

◆ ComputeExpandedDrawAreaGeometry()

vtkRecti vtkContextArea::ComputeExpandedDrawAreaGeometry ( vtkContext2D painter)
protected

Working implementations for ComputeDrawAreaGeometry.

◆ ComputeFixedAspectDrawAreaGeometry()

vtkRecti vtkContextArea::ComputeFixedAspectDrawAreaGeometry ( vtkContext2D painter)
protected

◆ ComputeFixedRectDrawAreaGeometry()

vtkRecti vtkContextArea::ComputeFixedRectDrawAreaGeometry ( vtkContext2D painter)
protected

◆ ComputeFixedMarginsDrawAreaGeometry()

vtkRecti vtkContextArea::ComputeFixedMarginsDrawAreaGeometry ( vtkContext2D painter)
protected

◆ UpdateDrawArea()

void vtkContextArea::UpdateDrawArea ( )
protected

Set the transform to map DrawAreaBounds to DrawAreaGeometry.

Should be called after LayoutAxes to ensure that DrawAreaGeometry is up to date.

◆ InitializeDrawArea()

virtual void vtkContextArea::InitializeDrawArea ( )
protectedvirtual

Initialize the drawing area's item hierarchy.

Member Data Documentation

◆ Axes

vtkTuple<vtkAxis*, 4> vtkContextArea::Axes
protected

vtkAxis objects that surround the draw area, indexed by vtkAxis::Location.

Definition at line 220 of file vtkContextArea.h.

◆ Grid

vtkNew<vtkPlotGrid> vtkContextArea::Grid
protected

The vtkPlotGrid that renders a grid atop the data in the draw area.

Definition at line 225 of file vtkContextArea.h.

◆ Clip

vtkNew<vtkContextClip> vtkContextArea::Clip
protected

The context item that clips rendered data.

Definition at line 230 of file vtkContextArea.h.

◆ Transform

vtkNew<vtkContextTransform> vtkContextArea::Transform
protected

The context item that clips rendered data.

Definition at line 235 of file vtkContextArea.h.

◆ Geometry

vtkRecti vtkContextArea::Geometry
protected

The rect defining the pixel location and size of the entire vtkContextArea, including axis label, title, etc.

Definition at line 241 of file vtkContextArea.h.

◆ DrawAreaBounds

vtkRectd vtkContextArea::DrawAreaBounds
protected

The data bounds of the clipped and transformed area inside of the axes.

This is used to configure the axes labels and setup the transform.

Definition at line 247 of file vtkContextArea.h.

◆ DrawAreaGeometry

vtkRecti vtkContextArea::DrawAreaGeometry
protected

The rect defining the pixel location and size of the clipped and transformed area inside the axes.

Relative to Geometry.

Definition at line 253 of file vtkContextArea.h.

◆ DrawAreaResizeBehavior

DrawAreaResizeBehaviorType vtkContextArea::DrawAreaResizeBehavior
protected

Controls how the draw area size is determined.

Definition at line 258 of file vtkContextArea.h.

◆ FixedAspect

float vtkContextArea::FixedAspect
protected

The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect.

Defined as width/height. Default is 1.

Definition at line 264 of file vtkContextArea.h.

◆ FixedRect

vtkRecti vtkContextArea::FixedRect
protected

The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect.

Units are in pixels, default is 300x300+0+0.

Definition at line 270 of file vtkContextArea.h.

◆ FixedMargins

Margins vtkContextArea::FixedMargins
protected

The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.

Units are in pixels, default is { 0, 0, 0, 0 }

Definition at line 277 of file vtkContextArea.h.

◆ FillViewport

bool vtkContextArea::FillViewport
protected

If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call.

vpSize is vtkContextDevice2D::GetViewportSize. Default is true.

Definition at line 284 of file vtkContextArea.h.

◆ TopAxis

vtkNew<vtkAxis> vtkContextArea::TopAxis
protected

Definition at line 292 of file vtkContextArea.h.

◆ BottomAxis

vtkNew<vtkAxis> vtkContextArea::BottomAxis
protected

Definition at line 293 of file vtkContextArea.h.

◆ LeftAxis

vtkNew<vtkAxis> vtkContextArea::LeftAxis
protected

Definition at line 294 of file vtkContextArea.h.

◆ RightAxis

vtkNew<vtkAxis> vtkContextArea::RightAxis
protected

Definition at line 295 of file vtkContextArea.h.


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