vtkContextScene Class Reference

#include <vtkContextScene.h>

Inheritance diagram for vtkContextScene:

[legend]

Collaboration diagram for vtkContextScene:

[legend]

List of all members.

Detailed Description

Provides a 2D scene for vtkContextItem objects.

Provides a 2D scene that vtkContextItem objects can be added to. Manages the items, ensures that they are rendered at the right times and passes on mouse events.

Tests:: vtkContextScene (Tests)

Definition at line 46 of file vtkContextScene.h.


Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual bool	Paint (vtkContext2D *painter)
unsigned int	AddItem (vtkAbstractContextItem *item)
bool	RemoveItem (vtkAbstractContextItem *item)
bool	RemoveItem (unsigned int index)
vtkAbstractContextItem *	GetItem (unsigned int index)
unsigned int	GetNumberOfItems ()
void	ClearItems ()
virtual void	SetAnnotationLink (vtkAnnotationLink *link)
virtual int	GetViewWidth ()
virtual int	GetViewHeight ()
int	GetSceneWidth ()
int	GetSceneHeight ()
virtual void	SetRenderer (vtkRenderer *renderer)
void	ReleaseGraphicsResources ()
vtkWeakPointer< vtkContext2D >	GetLastPainter ()
vtkAbstractContextBufferId *	GetBufferId ()
virtual void	SetTransform (vtkTransform2D *transform)
vtkTransform2D *	GetTransform ()
bool	HasTransform ()

virtual vtkAnnotationLink *	GetAnnotationLink ()

virtual void	SetGeometry (int, int)
void	SetGeometry (int[2])

virtual int *	GetGeometry ()
virtual void	GetGeometry (int &, int &)
virtual void	GetGeometry (int[2])

virtual void	SetUseBufferId (bool)

virtual bool	GetUseBufferId ()

virtual void	SetScaleTiles (bool)
virtual bool	GetScaleTiles ()
virtual void	ScaleTilesOn ()
virtual void	ScaleTilesOff ()

void	SetDirty (bool isDirty)
bool	GetDirty () const
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkContextScene *	SafeDownCast (vtkObject *o)
static vtkContextScene *	New ()
Protected Member Functions
	vtkContextScene ()
	~vtkContextScene ()
virtual bool	ProcessSelectionEvent (unsigned int rect[5])
virtual bool	MouseMoveEvent (int x, int y)
virtual bool	ButtonPressEvent (int button, int x, int y)
virtual bool	ButtonReleaseEvent (int button, int x, int y)
virtual bool	DoubleClickEvent (int button, int x, int y)
virtual bool	MouseWheelEvent (int delta, int x, int y)
virtual void	PaintIds ()
void	TestBufferIdSupport ()
vtkIdType	GetPickedItem (int x, int y)
vtkAbstractContextItem *	GetPickedItem ()
void	UpdateBufferId ()

virtual void	ProcessEvents (vtkObject caller, unsigned long eventId, void callData)
Protected Attributes
vtkAnnotationLink *	AnnotationLink
int	Geometry [2]
vtkContextScenePrivate *	Children
vtkWeakPointer< vtkContext2D >	LastPainter
vtkWeakPointer< vtkRenderer >	Renderer
vtkAbstractContextBufferId *	BufferId
bool	BufferIdDirty
bool	UseBufferId
bool	BufferIdSupportTested
bool	BufferIdSupported
bool	ScaleTiles
vtkTransform2D *	Transform

Private *	Storage
Friends
class	vtkContextInteractorStyle

Member Typedef Documentation

typedef vtkObject vtkContextScene::Superclass

Reimplemented from vtkObject.

Definition at line 49 of file vtkContextScene.h.

Constructor & Destructor Documentation

vtkContextScene::vtkContextScene ( ) [protected]

vtkContextScene::~vtkContextScene ( ) [protected]

Member Function Documentation

virtual const char* vtkContextScene::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

static int vtkContextScene::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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 vtkObject.

virtual int vtkContextScene::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 vtkObject.

static vtkContextScene* vtkContextScene::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

virtual void vtkContextScene::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 vtkObject.

static vtkContextScene* vtkContextScene::New ( ) [static]

Creates a 2D Painter object.

Reimplemented from vtkObject.

virtual bool vtkContextScene::Paint ( vtkContext2D * painter ) [virtual]

Paint event for the chart, called whenever the chart needs to be drawn

unsigned int vtkContextScene::AddItem ( vtkAbstractContextItem * item )

Add child items to this item. Increments reference count of item.

Returns:: the index of the child item.

bool vtkContextScene::RemoveItem ( vtkAbstractContextItem * item )

Remove child item from this item. Decrements reference count of item.

Parameters:

item

the item to be removed.

Returns:: true on success, false otherwise.

bool vtkContextScene::RemoveItem ( unsigned int index )

Remove child item from this item. Decrements reference count of item.

Parameters:

index

of the item to be removed.

Returns:: true on success, false otherwise.

vtkAbstractContextItem* vtkContextScene::GetItem ( unsigned int index )

Get the item at the specified index.

Returns:: the item at the specified index (null if index is invalid).

unsigned int vtkContextScene::GetNumberOfItems ( )

Get the number of child items.

void vtkContextScene::ClearItems ( )

Remove all child items from this item.

virtual void vtkContextScene::SetAnnotationLink ( vtkAnnotationLink * link ) [virtual]

Set the vtkAnnotationLink for the chart.

virtual vtkAnnotationLink* vtkContextScene::GetAnnotationLink ( ) [virtual]

Get the vtkAnnotationLink for the chart.

virtual void vtkContextScene::SetGeometry	(	int	,
		int
	)			`[virtual]`

Set the width and height of the scene in pixels.

void vtkContextScene::SetGeometry ( int [2] )

Set the width and height of the scene in pixels.

virtual int* vtkContextScene::GetGeometry ( ) [virtual]

Get the width and height of the scene in pixels.

virtual void vtkContextScene::GetGeometry	(	int &	,
		int &
	)			`[virtual]`

Get the width and height of the scene in pixels.

virtual void vtkContextScene::GetGeometry ( int [2] ) [virtual]

Get the width and height of the scene in pixels.

virtual void vtkContextScene::SetUseBufferId ( bool ) [virtual]

Set whether the scene should use the color buffer. Default is true.

virtual bool vtkContextScene::GetUseBufferId ( ) [virtual]

Get whether the scene is using the color buffer. Default is true.

virtual int vtkContextScene::GetViewWidth ( ) [virtual]

Get the width of the view

virtual int vtkContextScene::GetViewHeight ( ) [virtual]

Get the height of the view

int vtkContextScene::GetSceneWidth ( )

Get the width of the scene.

int vtkContextScene::GetSceneHeight ( )

Get the height of the scene.

virtual void vtkContextScene::SetScaleTiles ( bool ) [virtual]

Whether to scale the scene transform when tiling, for example when using vtkWindowToImageFilter to take a large screenshot. The default is true.

virtual bool vtkContextScene::GetScaleTiles ( ) [virtual]

Whether to scale the scene transform when tiling, for example when using vtkWindowToImageFilter to take a large screenshot. The default is true.

virtual void vtkContextScene::ScaleTilesOn ( ) [virtual]

Whether to scale the scene transform when tiling, for example when using vtkWindowToImageFilter to take a large screenshot. The default is true.

virtual void vtkContextScene::ScaleTilesOff ( ) [virtual]

Whether to scale the scene transform when tiling, for example when using vtkWindowToImageFilter to take a large screenshot. The default is true.

virtual void vtkContextScene::SetRenderer ( vtkRenderer * renderer ) [virtual]

This should not be necessary as the context view should take care of rendering.

void vtkContextScene::SetDirty ( bool isDirty )

Inform the scene that something changed that requires a repaint of the scene. This should only be used by the vtkContextItem derived objects in a scene in their event handlers.

bool vtkContextScene::GetDirty ( ) const

Inform the scene that something changed that requires a repaint of the scene. This should only be used by the vtkContextItem derived objects in a scene in their event handlers.

void vtkContextScene::ReleaseGraphicsResources ( )

Release graphics resources hold by the scene.

vtkWeakPointer<vtkContext2D> vtkContextScene::GetLastPainter ( )

Last painter used. Not part of the end-user API. Can be used by context items to create their own colorbuffer id (when a context item is a container).

vtkAbstractContextBufferId* vtkContextScene::GetBufferId ( )

Return buffer id. Not part of the end-user API. Can be used by context items to initialize their own colorbuffer id (when a context item is a container).

virtual void vtkContextScene::SetTransform ( vtkTransform2D * transform ) [virtual]

Set the transform for the scene.

vtkTransform2D* vtkContextScene::GetTransform ( )

Get the transform for the scene.

bool vtkContextScene::HasTransform ( ) [inline]

Check whether the scene has a transform.

Definition at line 165 of file vtkContextScene.h.

virtual void vtkContextScene::ProcessEvents	(	vtkObject *	caller,
		unsigned long	eventId,
		void *	callData
	)			`[protected, virtual]`

Called to process events - figure out what child(ren) to propagate events to.

virtual bool vtkContextScene::ProcessSelectionEvent ( unsigned int rect[5] ) [protected, virtual]

Process a rubber band selection event.

virtual bool vtkContextScene::MouseMoveEvent	(	int	x,
		int	y
	)			`[protected, virtual]`

Process a mouse move event.

virtual bool vtkContextScene::ButtonPressEvent	(	int	button,
		int	x,
		int	y
	)			`[protected, virtual]`

Process a mouse button press event.

virtual bool vtkContextScene::ButtonReleaseEvent	(	int	button,
		int	x,
		int	y
	)			`[protected, virtual]`

Process a mouse button release event.

virtual bool vtkContextScene::DoubleClickEvent	(	int	button,
		int	x,
		int	y
	)			`[protected, virtual]`

Process a mouse button double click event.

virtual bool vtkContextScene::MouseWheelEvent	(	int	delta,
		int	x,
		int	y
	)			`[protected, virtual]`

Process a mouse wheel event where delta is the movement forward or back.

virtual void vtkContextScene::PaintIds ( ) [protected, virtual]

Paint the scene in a special mode to build a cache for picking. Use internally.

void vtkContextScene::TestBufferIdSupport ( ) [protected]

Test if BufferId is supported by the OpenGL context.

vtkIdType vtkContextScene::GetPickedItem	(	int	x,
		int	y
	)			`[protected]`

Return the item id under mouse cursor at position (x,y). Return -1 if there is no item under the mouse cursor.

Postcondition:: valid_result: result>=-1 && result<this->GetNumberOfItems()

vtkAbstractContextItem* vtkContextScene::GetPickedItem ( ) [protected]

Return the item under the mouse. If no item is under the mouse, the method returns a null pointer.

void vtkContextScene::UpdateBufferId ( ) [protected]

Make sure the buffer id used for picking is up-to-date.

Friends And Related Function Documentation

friend class vtkContextInteractorStyle [friend]

The command object for the charts. class Command; friend class Command; Command *Observer;

Definition at line 223 of file vtkContextScene.h.

Member Data Documentation

vtkAnnotationLink* vtkContextScene::AnnotationLink [protected]

Definition at line 216 of file vtkContextScene.h.

int vtkContextScene::Geometry[2] [protected]

Definition at line 219 of file vtkContextScene.h.

Private* vtkContextScene::Storage [protected]

Definition at line 227 of file vtkContextScene.h.

vtkContextScenePrivate* vtkContextScene::Children [protected]

This structure provides a list of children, along with convenience functions to paint the children etc. It is derived from std::vector<vtkAbstractContextItem>, defined in a private header.

Definition at line 234 of file vtkContextScene.h.

vtkWeakPointer<vtkContext2D> vtkContextScene::LastPainter [protected]

Definition at line 236 of file vtkContextScene.h.

vtkWeakPointer<vtkRenderer> vtkContextScene::Renderer [protected]

Definition at line 238 of file vtkContextScene.h.

vtkAbstractContextBufferId* vtkContextScene::BufferId [protected]

Definition at line 240 of file vtkContextScene.h.

bool vtkContextScene::BufferIdDirty [protected]

Definition at line 241 of file vtkContextScene.h.

bool vtkContextScene::UseBufferId [protected]

Definition at line 243 of file vtkContextScene.h.

bool vtkContextScene::BufferIdSupportTested [protected]