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

#include <vtkContextArea.h>

Inheritance diagram for vtkContextArea:

Collaboration diagram for vtkContextArea:

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.

vtkContextArea *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkAxis *	GetAxis (vtkAxis::Location location)
	Get the vtkAxis associated with the specified location.

vtkAbstractContextItem *	GetDrawAreaItem ()
	Returns the vtkAbstractContextItem that will draw in the clipped, transformed space.

bool	Paint (vtkContext2D *painter) override
	Paint event for the item, called whenever the item needs to be drawn.


virtual vtkRecti	GetGeometry ()
	The rect defining the pixel location and size of the entire vtkContextArea, including axis labels, title, etc.

virtual void	SetGeometry (vtkRecti)
	The rect defining the pixel location and size of the entire vtkContextArea, including axis labels, title, etc.


virtual vtkRectd	GetDrawAreaBounds ()
	The data bounds of the clipped and transformed area inside of the axes.

virtual void	SetDrawAreaBounds (vtkRectd)
	The data bounds of the clipped and transformed area inside of the axes.


virtual DrawAreaResizeBehaviorType	GetDrawAreaResizeBehavior ()
	Set the resize behavior for the draw area:

virtual void	SetDrawAreaResizeBehavior (DrawAreaResizeBehaviorType)
	Set the resize behavior for the draw area:


virtual float	GetFixedAspect ()
	The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect.

virtual void	SetFixedAspect (float aspect)
	The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect.


virtual vtkRecti	GetFixedRect ()
	The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect.

virtual void	SetFixedRect (vtkRecti rect)
	The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect.

virtual void	SetFixedRect (int x, int y, int width, int height)
	The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect.


virtual const Margins &	GetFixedMargins ()
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.

virtual void	GetFixedMarginsArray (int margins[4])
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.

virtual const int *	GetFixedMarginsArray ()
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.

virtual void	SetFixedMargins (Margins margins)
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.

virtual void	SetFixedMargins (int margins[4])
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.

virtual void	SetFixedMargins (int left, int right, int bottom, int top)
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.


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

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

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

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


virtual void	SetShowGrid (bool show)
	Turn on/off grid visibility.

virtual bool	GetShowGrid ()
	Turn on/off grid visibility.

virtual void	ShowGridOn ()
	Turn on/off grid visibility.

virtual void	ShowGridOff ()
	Turn on/off grid visibility.

Public Member Functions inherited from vtkAbstractContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAbstractContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	Update ()
	Perform any updates to the item that may be necessary before rendering.

virtual bool	Paint (vtkContext2D *painter)
	Paint event for the item, called whenever the item needs to be drawn.

virtual bool	PaintChildren (vtkContext2D *painter)
	Paint the children of the item, should be called whenever the children need to be rendered.

virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item.

vtkIdType	AddItem (vtkAbstractContextItem *item)
	Add child items to this item.

bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item.

bool	RemoveItem (vtkIdType index)
	Remove child item from this item.

vtkAbstractContextItem *	GetItem (vtkIdType index)
	Get the item at the specified index.

vtkIdType	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item in itemIndex.

vtkIdType	GetNumberOfItems ()
	Get the number of child items.

void	ClearItems ()
	Remove all child items from this item.

vtkIdType	Raise (vtkIdType index)
	Raises the child to the top of the item's stack.

virtual vtkIdType	StackAbove (vtkIdType index, vtkIdType under)
	Raises the child above the under sibling.

vtkIdType	Lower (vtkIdType index)
	Lowers the child to the bottom of the item's stack.

virtual vtkIdType	StackUnder (vtkIdType child, vtkIdType above)
	Lowers the child under the above sibling.

virtual bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item.

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse.

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event.

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event.

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event.

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.

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
	Mouse button release event.

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event.

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
	Mouse wheel event, positive delta indicates forward movement of the wheel.

virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
	Key press event.

virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
	Key release event.

virtual void	SetScene (vtkContextScene *scene)
	Set the vtkContextScene for the item, always set for an item in a scene.

vtkContextScene *	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene.

virtual void	SetParent (vtkAbstractContextItem *parent)
	Set the parent item.

vtkAbstractContextItem *	GetParent ()
	Get the parent item.

virtual vtkVector2f	MapToParent (const vtkVector2f &point)
	Maps the point to the parent coordinate system.

virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
	Maps the point from the parent coordinate system.

virtual vtkVector2f	MapToScene (const vtkVector2f &point)
	Maps the point to the scene coordinate system.

virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
	Maps the point from the scene coordinate system.

virtual bool	GetVisible ()
	Get the visibility of the item (should it be drawn).

virtual void	SetVisible (bool)
	Set the visibility of the item (should it be drawn).

virtual bool	GetInteractive ()
	Get if the item is interactive (should respond to mouse events).

virtual void	SetInteractive (bool)
	Set if the item is interactive (should respond to mouse events).

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 vtkContextArea *	SafeDownCast (vtkObjectBase *o)

static vtkContextArea *	New ()

Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)

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

	vtkContextArea ()

	~vtkContextArea () override

void	LayoutAxes (vtkContext2D *painter)
	Sync the Axes locations with Geometry, and update the DrawAreaGeometry to account for Axes size (margins).

virtual void	SetAxisRange (vtkRectd const &data)

virtual void	ComputeViewTransform ()

vtkRecti	ComputeDrawAreaGeometry (vtkContext2D *painter)
	Return the draw area's geometry.

void	UpdateDrawArea ()
	Set the transform to map DrawAreaBounds to DrawAreaGeometry.

virtual void	InitializeDrawArea ()
	Initialize the drawing area's item hierarchy.


vtkRecti	ComputeExpandedDrawAreaGeometry (vtkContext2D *painter)
	Working implementations for ComputeDrawAreaGeometry.

vtkRecti	ComputeFixedAspectDrawAreaGeometry (vtkContext2D *painter)
	Working implementations for ComputeDrawAreaGeometry.

vtkRecti	ComputeFixedRectDrawAreaGeometry (vtkContext2D *painter)
	Working implementations for ComputeDrawAreaGeometry.

vtkRecti	ComputeFixedMarginsDrawAreaGeometry (vtkContext2D *painter)
	Working implementations for ComputeDrawAreaGeometry.

Protected Member Functions inherited from vtkAbstractContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractContextItem ()

	~vtkAbstractContextItem () override

virtual void	ReleaseGraphicsCache ()
	Release cache entries created by this context item.

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
vtkTuple< vtkAxis *, 4 >	Axes
	vtkAxis objects that surround the draw area, indexed by vtkAxis::Location.

vtkNew< vtkPlotGrid >	Grid
	The vtkPlotGrid that renders a grid atop the data in the draw area.

vtkNew< vtkContextClip >	Clip
	The context item that clips rendered data.

vtkNew< vtkContextTransform >	Transform
	The context item that clips rendered data.

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

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

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

DrawAreaResizeBehaviorType	DrawAreaResizeBehavior
	Controls how the draw area size is determined.

float	FixedAspect
	The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect.

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

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

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

vtkNew< vtkAxis >	TopAxis

vtkNew< vtkAxis >	BottomAxis

vtkNew< vtkAxis >	LeftAxis

vtkNew< vtkAxis >	RightAxis

Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
	Point to the scene the item is on - can be null.

vtkAbstractContextItem *	Parent
	Point to the parent item - can be null.

vtkContextScenePrivate *	Children
	This structure provides a list of children, along with convenience functions to paint the children etc.

bool	Visible
	Store the visibility of the item (default is true).

bool	Interactive
	Store whether the item should respond to interactions (default is true).

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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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:

Geometry: The rect (pixel coordinates) defining the location of the context area in the scene. This includes the draw area and axis ticks/labels.
FillViewport: If true (default), Geometry is set to span the size returned by vtkContextDevice2D::GetViewportSize().
DrawAreaResizeBehavior: Controls how the draw area should be shaped. Available options: Expand (default), FixedAspect, FixedRect, FixedMargins.
FixedAspect: Aspect ratio to enforce for FixedAspect resize behavior.
FixedRect: Rect used to enforce for FixedRect resize behavior.
FixedMargins: Margins to enforce for FixedMargins resize behavior.

Tests:
vtkContextArea (Tests)

Definition at line 47 of file vtkContextArea.h.

Member Typedef Documentation

◆ Margins

typedef vtkTuple<int, 4> vtkContextArea::Margins

Definition at line 50 of file vtkContextArea.h.

◆ Superclass

typedef vtkAbstractContextItem vtkContextArea::Superclass

Definition at line 51 of file vtkContextArea.h.

Member Enumeration Documentation

◆ DrawAreaResizeBehaviorType

enum vtkContextArea::DrawAreaResizeBehaviorType

Enumerator
DARB_Expand
DARB_FixedAspect
DARB_FixedRect
DARB_FixedMargins

Definition at line 91 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 vtkAbstractContextItem.

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

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.

◆ 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

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.

◆ 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

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.

◆ 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

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.

◆ 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

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() [2/2]

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

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.

◆ 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 148 of file vtkContextArea.h.

◆ GetFixedMarginsArray() [1/2]

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

virtual

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.

◆ GetFixedMarginsArray() [2/2]

virtual const int * vtkContextArea::GetFixedMarginsArray ( )

virtual

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.

◆ SetFixedMargins() [1/3]

virtual void vtkContextArea::SetFixedMargins ( Margins margins )

virtual

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.

◆ SetFixedMargins() [2/3]

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

virtual

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.

◆ SetFixedMargins() [3/3]

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

virtual

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.

◆ 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

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.

◆ FillViewportOn()

virtual void vtkContextArea::FillViewportOn ( )

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.

◆ FillViewportOff()

virtual void vtkContextArea::FillViewportOff ( )

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.

◆ SetShowGrid()

virtual void vtkContextArea::SetShowGrid ( bool show )

virtual

Turn on/off grid visibility.

◆ GetShowGrid()

virtual bool vtkContextArea::GetShowGrid ( )

virtual

Turn on/off grid visibility.

◆ ShowGridOn()

virtual void vtkContextArea::ShowGridOn ( )

inlinevirtual

Turn on/off grid visibility.

Definition at line 173 of file vtkContextArea.h.

◆ ShowGridOff()

virtual void vtkContextArea::ShowGridOff ( )

inlinevirtual

Turn on/off grid visibility.

Definition at line 174 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

Working implementations for ComputeDrawAreaGeometry.

◆ ComputeFixedRectDrawAreaGeometry()

vtkRecti vtkContextArea::ComputeFixedRectDrawAreaGeometry ( vtkContext2D * painter )

protected

Working implementations for ComputeDrawAreaGeometry.

◆ ComputeFixedMarginsDrawAreaGeometry()

vtkRecti vtkContextArea::ComputeFixedMarginsDrawAreaGeometry ( vtkContext2D * painter )

protected

Working implementations for ComputeDrawAreaGeometry.

◆ 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 214 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 219 of file vtkContextArea.h.

◆ Clip

vtkNew<vtkContextClip> vtkContextArea::Clip

protected

The context item that clips rendered data.

Definition at line 224 of file vtkContextArea.h.

◆ Transform

vtkNew<vtkContextTransform> vtkContextArea::Transform

protected

The context item that clips rendered data.

Definition at line 229 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 235 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 241 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 247 of file vtkContextArea.h.

◆ DrawAreaResizeBehavior

DrawAreaResizeBehaviorType vtkContextArea::DrawAreaResizeBehavior

protected

Controls how the draw area size is determined.

Definition at line 252 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 258 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 264 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 271 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 278 of file vtkContextArea.h.

◆ TopAxis

vtkNew<vtkAxis> vtkContextArea::TopAxis

protected

Definition at line 286 of file vtkContextArea.h.

◆ BottomAxis

vtkNew<vtkAxis> vtkContextArea::BottomAxis

protected

Definition at line 287 of file vtkContextArea.h.

◆ LeftAxis

vtkNew<vtkAxis> vtkContextArea::LeftAxis

protected

Definition at line 288 of file vtkContextArea.h.

◆ RightAxis

vtkNew<vtkAxis> vtkContextArea::RightAxis

protected

Definition at line 289 of file vtkContextArea.h.

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

Charts/Core/vtkContextArea.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Margins

◆ Superclass

Member Enumeration Documentation

◆ DrawAreaResizeBehaviorType

Constructor & Destructor Documentation

◆ vtkContextArea()

◆ ~vtkContextArea()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ GetAxis()

◆ GetDrawAreaItem()

◆ Paint()

◆ GetGeometry()

◆ SetGeometry()

◆ GetDrawAreaBounds()

◆ SetDrawAreaBounds()

◆ GetDrawAreaResizeBehavior()

◆ SetDrawAreaResizeBehavior()

◆ GetFixedAspect()

◆ SetFixedAspect()

◆ GetFixedRect()

◆ SetFixedRect() [1/2]

◆ SetFixedRect() [2/2]

◆ GetFixedMargins()

◆ GetFixedMarginsArray() [1/2]

◆ GetFixedMarginsArray() [2/2]

◆ SetFixedMargins() [1/3]

◆ SetFixedMargins() [2/3]

◆ SetFixedMargins() [3/3]

◆ GetFillViewport()

◆ SetFillViewport()

◆ FillViewportOn()

◆ FillViewportOff()

◆ SetShowGrid()

◆ GetShowGrid()

◆ ShowGridOn()

◆ ShowGridOff()

◆ LayoutAxes()

◆ SetAxisRange()

◆ ComputeViewTransform()

◆ ComputeDrawAreaGeometry()

◆ ComputeExpandedDrawAreaGeometry()

◆ ComputeFixedAspectDrawAreaGeometry()

◆ ComputeFixedRectDrawAreaGeometry()

◆ ComputeFixedMarginsDrawAreaGeometry()

◆ UpdateDrawArea()

◆ InitializeDrawArea()

Member Data Documentation

◆ Axes

◆ Grid

◆ Clip

◆ Transform

◆ Geometry

◆ DrawAreaBounds

◆ DrawAreaGeometry

◆ DrawAreaResizeBehavior

◆ FixedAspect

◆ FixedRect

◆ FixedMargins

◆ FillViewport

◆ TopAxis

◆ BottomAxis

◆ LeftAxis

◆ RightAxis