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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkContextArea *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

vtkAxis *	GetAxis (vtkAxis::Location location)

vtkAbstractContextItem *	GetDrawAreaItem ()

virtual bool	Paint (vtkContext2D *painter)


virtual vtkRecti	GetGeometry ()

virtual void	SetGeometry (vtkRecti)


virtual vtkRectd	GetDrawAreaBounds ()

virtual void	SetDrawAreaBounds (vtkRectd)


virtual DrawAreaResizeBehaviorType	GetDrawAreaResizeBehavior ()

virtual void	SetDrawAreaResizeBehavior (DrawAreaResizeBehaviorType)


virtual float	GetFixedAspect ()

virtual void	SetFixedAspect (float aspect)


virtual vtkRecti	GetFixedRect ()

virtual void	SetFixedRect (vtkRecti rect)

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


virtual const Margins &	GetFixedMargins ()

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 ()

virtual void	SetFillViewport (bool)

virtual void	FillViewportOn ()

virtual void	FillViewportOff ()


virtual void	SetShowGrid (bool show)

virtual bool	GetShowGrid ()

virtual void	ShowGridOn ()

virtual void	ShowGridOff ()

Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItem *	NewInstance () const

virtual void	Update ()

virtual bool	PaintChildren (vtkContext2D *painter)

virtual void	ReleaseGraphicsResources ()

unsigned int	AddItem (vtkAbstractContextItem *item)

bool	RemoveItem (vtkAbstractContextItem *item)

bool	RemoveItem (unsigned int index)

vtkAbstractContextItem *	GetItem (unsigned int index)

unsigned int	GetItemIndex (vtkAbstractContextItem *item)

unsigned int	GetNumberOfItems ()

void	ClearItems ()

unsigned int	Raise (unsigned int index)

unsigned int	Lower (unsigned int index)

virtual bool	Hit (const vtkContextMouseEvent &mouse)

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)

virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)

virtual void	SetScene (vtkContextScene *scene)

virtual void	SetParent (vtkAbstractContextItem *parent)

virtual vtkVector2f	MapToParent (const vtkVector2f &point)

virtual vtkVector2f	MapFromParent (const vtkVector2f &point)

virtual vtkVector2f	MapToScene (const vtkVector2f &point)

virtual vtkVector2f	MapFromScene (const vtkVector2f &point)

virtual unsigned int	StackAbove (unsigned int index, unsigned int under)

virtual unsigned int	StackUnder (unsigned int child, unsigned int above)

virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)

vtkContextScene *	GetScene ()

vtkAbstractContextItem *	GetParent ()

virtual bool	GetVisible ()

virtual void	SetVisible (bool)

virtual bool	GetInteractive ()

virtual void	SetInteractive (bool)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkContextArea *	SafeDownCast (vtkObjectBase *o)

static vtkContextArea *	New ()

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

static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkContextArea ()

	~vtkContextArea ()

void	LayoutAxes (vtkContext2D *painter)

vtkRecti	ComputeDrawAreaGeometry (vtkContext2D *painter)

void	UpdateDrawArea ()


vtkRecti	ComputeExpandedDrawAreaGeometry (vtkContext2D *painter)

vtkRecti	ComputeFixedAspectDrawAreaGeometry (vtkContext2D *painter)

vtkRecti	ComputeFixedRectDrawAreaGeometry (vtkContext2D *painter)

vtkRecti	ComputeFixedMarginsDrawAreaGeometry (vtkContext2D *painter)

Protected Member Functions inherited from vtkAbstractContextItem
	vtkAbstractContextItem ()

	~vtkAbstractContextItem ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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

vtkNew< vtkPlotGrid >	Grid

vtkNew< vtkContextClip >	Clip

vtkNew< vtkContextTransform >	Transform

vtkRecti	Geometry

vtkRectd	DrawAreaBounds

vtkRecti	DrawAreaGeometry

DrawAreaResizeBehaviorType	DrawAreaResizeBehavior

float	FixedAspect

vtkRecti	FixedRect

Margins	FixedMargins

bool	FillViewport

Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene

vtkAbstractContextItem *	Parent

vtkContextScenePrivate *	Children

bool	Visible

bool	Interactive

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	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:

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

Member Typedef Documentation

typedef vtkTuple<int, 4> vtkContextArea::Margins

Definition at line 59 of file vtkContextArea.h.

typedef vtkAbstractContextItem vtkContextArea::Superclass

Definition at line 60 of file vtkContextArea.h.

Member Enumeration Documentation

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 ( )

protected

vtkContextArea::~vtkContextArea ( )

protected

Member Function Documentation

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

static

virtual int 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.

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

static

virtual vtkObjectBase* vtkContextArea::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractContextItem.

vtkContextArea* vtkContextArea::NewInstance ( ) const

virtual void vtkContextArea::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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.

static vtkContextArea* vtkContextArea::New ( )

static

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

Get the vtkAxis associated with the specified location.

vtkAbstractContextItem* vtkContextArea::GetDrawAreaItem ( )

Returns the vtkAbstractContextItem that will draw in the clipped, transformed space. This is the item to add children for.

virtual bool vtkContextArea::Paint ( vtkContext2D * painter )

virtual

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

Reimplemented from vtkAbstractContextItem.

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.

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.

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.

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.

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

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

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.

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.

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.

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.

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.

virtual const Margins& vtkContextArea::GetFixedMargins ( )

inlinevirtual