#include <vtkBorderRepresentation.h>

Inheritance diagram for vtkBorderRepresentation:

Collaboration diagram for vtkBorderRepresentation:

Public Types
enum	{ BORDER_OFF =0, BORDER_ON, BORDER_ACTIVE }

enum	_InteractionState { Outside =0, Inside, AdjustingP0, AdjustingP1, AdjustingP2, AdjustingP3, AdjustingE0, AdjustingE1, AdjustingE2, AdjustingE3 }
	Define the various states that the representation can be in. More...

Public Types inherited from vtkWidgetRepresentation
typedef vtkProp	Superclass
	Standard methods for instances of this class. More...

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
virtual vtkMTimeType	GetMTime ()
	Return the MTime of this object. More...


virtual vtkCoordinate *	GetPositionCoordinate ()
	Specify opposite corners of the box defining the boundary of the widget. More...

virtual void	SetPosition (float x[2])
	Specify opposite corners of the box defining the boundary of the widget. More...

virtual void	SetPosition (float x, float y)
	Specify opposite corners of the box defining the boundary of the widget. More...

virtual float *	GetPosition ()
	Specify opposite corners of the box defining the boundary of the widget. More...

virtual vtkCoordinate *	GetPosition2Coordinate ()
	Specify opposite corners of the box defining the boundary of the widget. More...

virtual void	SetPosition2 (float x[2])
	Specify opposite corners of the box defining the boundary of the widget. More...

virtual void	SetPosition2 (float x, float y)
	Specify opposite corners of the box defining the boundary of the widget. More...

virtual float *	GetPosition2 ()
	Specify opposite corners of the box defining the boundary of the widget. More...


virtual void	SetShowBorder (int border)
	Specify when and if the border should appear. More...

virtual int	GetShowBorderMinValue ()
	Specify when and if the border should appear. More...

virtual int	GetShowBorderMaxValue ()
	Specify when and if the border should appear. More...

virtual int	GetShowBorder ()
	Specify when and if the border should appear. More...

void	SetShowBorderToOff ()
	Specify when and if the border should appear. More...

void	SetShowBorderToOn ()
	Specify when and if the border should appear. More...

void	SetShowBorderToActive ()
	Specify when and if the border should appear. More...


virtual void	SetShowVerticalBorder (int)
	Specify when and if the vertical border should appear. More...

virtual int	GetShowVerticalBorder ()
	Specify when and if the vertical border should appear. More...


virtual void	SetShowHorizontalBorder (int)
	Specify when and if the horizontal border should appear. More...

virtual int	GetShowHorizontalBorder ()
	Specify when and if the horizontal border should appear. More...


virtual vtkProperty2D *	GetBorderProperty ()
	Specify the properties of the border. More...


virtual void	SetProportionalResize (int)
	Indicate whether resizing operations should keep the x-y directions proportional to one another. More...

virtual int	GetProportionalResize ()
	Indicate whether resizing operations should keep the x-y directions proportional to one another. More...

virtual void	ProportionalResizeOn ()
	Indicate whether resizing operations should keep the x-y directions proportional to one another. More...

virtual void	ProportionalResizeOff ()
	Indicate whether resizing operations should keep the x-y directions proportional to one another. More...


virtual void	SetMinimumSize (int, int)
	Specify a minimum and/or maximum size (in pixels) that this representation can take. More...

void	SetMinimumSize (int[2])
	Specify a minimum and/or maximum size (in pixels) that this representation can take. More...

virtual int *	GetMinimumSize ()
	Specify a minimum and/or maximum size (in pixels) that this representation can take. More...

virtual void	GetMinimumSize (int &, int &)
	Specify a minimum and/or maximum size (in pixels) that this representation can take. More...

virtual void	GetMinimumSize (int[2])
	Specify a minimum and/or maximum size (in pixels) that this representation can take. More...

virtual void	SetMaximumSize (int, int)
	Specify a minimum and/or maximum size (in pixels) that this representation can take. More...

void	SetMaximumSize (int[2])
	Specify a minimum and/or maximum size (in pixels) that this representation can take. More...

virtual int *	GetMaximumSize ()
	Specify a minimum and/or maximum size (in pixels) that this representation can take. More...

virtual void	GetMaximumSize (int &, int &)
	Specify a minimum and/or maximum size (in pixels) that this representation can take. More...

virtual void	GetMaximumSize (int[2])
	Specify a minimum and/or maximum size (in pixels) that this representation can take. More...


virtual void	SetTolerance (int)
	The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge). More...

virtual int	GetTolerance ()
	The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge). More...


virtual double *	GetSelectionPoint ()
	After a selection event within the region interior to the border; the normalized selection coordinates may be obtained. More...

virtual void	GetSelectionPoint (double data[2])
	After a selection event within the region interior to the border; the normalized selection coordinates may be obtained. More...


virtual void	SetMoving (int)
	This is a modifier of the interaction state. More...

virtual int	GetMoving ()
	This is a modifier of the interaction state. More...

virtual void	MovingOn ()
	This is a modifier of the interaction state. More...

virtual void	MovingOff ()
	This is a modifier of the interaction state. More...


virtual void	BuildRepresentation ()
	Subclasses should implement these methods. More...

virtual void	StartWidgetInteraction (double eventPos[2])
	Subclasses should implement these methods. More...

virtual void	WidgetInteraction (double eventPos[2])
	Subclasses should implement these methods. More...

virtual void	GetSize (double size[2])
	Subclasses should implement these methods. More...

virtual int	ComputeInteractionState (int X, int Y, int modify=0)
	Subclasses should implement these methods. More...


virtual void	GetActors2D (vtkPropCollection *)
	These methods are necessary to make this representation behave as a vtkProp. More...

virtual void	ReleaseGraphicsResources (vtkWindow *)
	These methods are necessary to make this representation behave as a vtkProp. More...

virtual int	RenderOverlay (vtkViewport *)
	These methods are necessary to make this representation behave as a vtkProp. More...

virtual int	RenderOpaqueGeometry (vtkViewport *)
	These methods are necessary to make this representation behave as a vtkProp. More...

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
	These methods are necessary to make this representation behave as a vtkProp. More...

virtual int	HasTranslucentPolygonalGeometry ()
	These methods are necessary to make this representation behave as a vtkProp. More...

Public Member Functions inherited from vtkWidgetRepresentation
virtual void	PlaceWidget (double *vtkNotUsed(bounds[6]))
	The following is a suggested API for widget representations. More...

virtual void	EndWidgetInteraction (double newEventPos[2])

virtual int	GetInteractionState ()

virtual void	Highlight (int vtkNotUsed(highlightOn))

virtual double *	GetBounds ()
	Methods to make this class behave as a vtkProp. More...

virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp. More...

virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes. More...

virtual void	GetVolumes (vtkPropCollection *)

virtual int	RenderOverlay (vtkViewport *vtkNotUsed(viewport))

virtual int	RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport))

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport))

virtual int	RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport))

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	SetPickingManaged (bool)
	Enable/Disable the use of a manager to process the picking. More...

virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	SetRenderer (vtkRenderer *ren)
	Subclasses of vtkWidgetRepresentation must implement these methods. More...

virtual vtkRenderer *	GetRenderer ()
	Subclasses of vtkWidgetRepresentation must implement these methods. More...

virtual void	SetPlaceFactor (double)
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...

virtual double	GetPlaceFactor ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...

virtual void	SetHandleSize (double)
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...

virtual double	GetHandleSize ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...

virtual int	GetNeedToRender ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...

virtual void	SetNeedToRender (int)
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...

virtual void	NeedToRenderOn ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...

virtual void	NeedToRenderOff ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...

vtkWidgetRepresentation *	NewInstance () const
	Standard methods for instances of this class. More...

void	PrintSelf (ostream &os, vtkIndent indent)
	Standard methods for instances of this class. More...

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

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

virtual void	Pick ()
	Method fires PickEvent if the prop is picked. More...

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently. More...

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...

virtual vtkMatrix4x4 *	GetMatrix ()

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys. More...

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys. More...

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...

virtual void	SetVisibility (int)
	Set/Get visibility of this vtkProp. More...

virtual int	GetVisibility ()
	Set/Get visibility of this vtkProp. More...

virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp. More...

virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp. More...

virtual void	SetPickable (int)
	Set/Get the pickable instance variable. More...

virtual int	GetPickable ()
	Set/Get the pickable instance variable. More...

virtual void	PickableOn ()
	Set/Get the pickable instance variable. More...

virtual void	PickableOff ()
	Set/Get the pickable instance variable. More...

virtual void	SetDragable (int)
	Set/Get the value of the dragable instance variable. More...

virtual int	GetDragable ()
	Set/Get the value of the dragable instance variable. More...

virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable. More...

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable. More...

virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys. More...

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys. More...

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

virtual int	GetNumberOfConsumers ()
	Get the number of consumers. More...

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,. More...

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

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

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

Static Public Member Functions
static vtkBorderRepresentation *	New ()
	Instantiate this class. More...

Static Public Member Functions inherited from vtkWidgetRepresentation
static int	IsTypeOf (const char *type)
	Standard methods for instances of this class. More...

static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class. More...

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

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
	vtkBorderRepresentation ()

	~vtkBorderRepresentation ()

virtual void	NegotiateLayout ()

virtual void	UpdateShowBorder ()

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation ()

void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager. More...

virtual void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager. More...

virtual void	PickersModified ()
	Update the pickers registered in the Picking Manager when pickers are modified. More...

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the widget representation currently belong. More...

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path. More...

double	SizeHandlesRelativeToViewport (double factor, double pos[3])

double	SizeHandlesInPixels (double factor, double pos[3])

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp ()

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	ShowVerticalBorder

int	ShowHorizontalBorder

vtkProperty2D *	BorderProperty

int	ProportionalResize

int	Tolerance

int	Moving

double	SelectionPoint [2]

vtkCoordinate *	PositionCoordinate

vtkCoordinate *	Position2Coordinate

int	Negotiated

double	StartPosition [2]

vtkPoints *	BWPoints

vtkPolyData *	BWPolyData

vtkTransform *	BWTransform

vtkTransformPolyDataFilter *	BWTransformFilter

vtkPolyDataMapper2D *	BWMapper

vtkActor2D *	BWActor

int	MinimumSize [2]

int	MaximumSize [2]

Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRenderer >	Renderer

int	InteractionState

double	StartEventPosition [3]

double	PlaceFactor

int	Placed

double	InitialBounds [6]

double	InitialLength

int	ValidPick

bool	PickingManaged

double	HandleSize

int	NeedToRender

vtkTimeStamp	BuildTime

Protected Attributes inherited from vtkProp
int	Visibility

int	Pickable

int	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkWidgetRepresentation	Superclass
	Define standard methods. More...

static int	IsTypeOf (const char *type)
	Define standard methods. More...

static vtkBorderRepresentation *	SafeDownCast (vtkObjectBase *o)
	Define standard methods. More...

virtual int	IsA (const char *type)
	Define standard methods. More...

vtkBorderRepresentation *	NewInstance () const
	Define standard methods. More...

void	PrintSelf (ostream &os, vtkIndent indent)
	Define standard methods. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Define standard methods. More...

Detailed Description

represent a vtkBorderWidget

This class is used to represent and render a vtBorderWidget. To use this class, you need to specify the two corners of a rectangular region.

The class is typically subclassed so that specialized representations can be created. The class defines an API and a default implementation that the vtkBorderRepresentation interacts with to render itself in the scene.

Warning: The separation of the widget event handling (e.g., vtkBorderWidget) from the representation (vtkBorderRepresentation) enables users and developers to create new appearances for the widget. It also facilitates parallel processing, where the client application handles events, and remote representations of the widget are slaves to the client (and do not handle events).

See also: vtkBorderWidget vtkTextWidget

Tests:: vtkBorderRepresentation (Tests)

Definition at line 58 of file vtkBorderRepresentation.h.

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkBorderRepresentation::Superclass

Define standard methods.

Definition at line 70 of file vtkBorderRepresentation.h.

Member Enumeration Documentation

anonymous enum

Enumerator
BORDER_OFF
BORDER_ON
BORDER_ACTIVE

Definition at line 88 of file vtkBorderRepresentation.h.

enum vtkBorderRepresentation::_InteractionState

Define the various states that the representation can be in.

Enumerator
Outside
Inside
AdjustingP0
AdjustingP1
AdjustingP2
AdjustingP3
AdjustingE0
AdjustingE1
AdjustingE2
AdjustingE3

Definition at line 193 of file vtkBorderRepresentation.h.

Constructor & Destructor Documentation

vtkBorderRepresentation::vtkBorderRepresentation ( )

protected

vtkBorderRepresentation::~vtkBorderRepresentation ( )

protected

Member Function Documentation

static vtkBorderRepresentation* vtkBorderRepresentation::New ( )

static

Instantiate this class.

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

static

Define standard methods.

virtual int vtkBorderRepresentation::IsA ( const char * type )

virtual

Define standard methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, vtkProgressBarRepresentation, and vtkXYPlotRepresentation.

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

static

Define standard methods.

virtual vtkObjectBase* vtkBorderRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Define standard methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, vtkProgressBarRepresentation, and vtkXYPlotRepresentation.

vtkBorderRepresentation* vtkBorderRepresentation::NewInstance ( ) const

Define standard methods.

void vtkBorderRepresentation::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Define standard methods.

Reimplemented from vtkObject.

Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, vtkProgressBarRepresentation, and vtkXYPlotRepresentation.

virtual vtkCoordinate* vtkBorderRepresentation::GetPositionCoordinate ( )

virtual

Specify opposite corners of the box defining the boundary of the widget.

By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.

virtual void vtkBorderRepresentation::SetPosition ( float x[2] )

virtual

Specify opposite corners of the box defining the boundary of the widget.

By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.

virtual void vtkBorderRepresentation::SetPosition	(	float	x,
		float	y
	)

virtual

Specify opposite corners of the box defining the boundary of the widget.

By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.

virtual float* vtkBorderRepresentation::GetPosition ( )

virtual

Specify opposite corners of the box defining the boundary of the widget.

By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.

virtual vtkCoordinate* vtkBorderRepresentation::GetPosition2Coordinate ( )

virtual

Specify opposite corners of the box defining the boundary of the widget.

By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.

virtual void vtkBorderRepresentation::SetPosition2 ( float x[2] )

virtual

Specify opposite corners of the box defining the boundary of the widget.

By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.

virtual void vtkBorderRepresentation::SetPosition2	(	float	x,
		float	y
	)

virtual

Specify opposite corners of the box defining the boundary of the widget.

By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.

virtual float* vtkBorderRepresentation::GetPosition2 ( )

virtual

Specify opposite corners of the box defining the boundary of the widget.

By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.

virtual void vtkBorderRepresentation::SetShowBorder ( int border )

virtual

Specify when and if the border should appear.

If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()

virtual int vtkBorderRepresentation::GetShowBorderMinValue ( )

virtual

Specify when and if the border should appear.

If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()

virtual int vtkBorderRepresentation::GetShowBorderMaxValue ( )

virtual

Specify when and if the border should appear.

If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()

virtual int vtkBorderRepresentation::GetShowBorder ( )

virtual

Specify when and if the border should appear.

If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()

void vtkBorderRepresentation::SetShowBorderToOff ( )

inline

Specify when and if the border should appear.

If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()

Definition at line 106 of file vtkBorderRepresentation.h.

void vtkBorderRepresentation::SetShowBorderToOn ( )

inline

Specify when and if the border should appear.

If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()

Definition at line 107 of file vtkBorderRepresentation.h.

void vtkBorderRepresentation::SetShowBorderToActive ( )

inline

Specify when and if the border should appear.

If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()

Definition at line 108 of file vtkBorderRepresentation.h.

virtual void vtkBorderRepresentation::SetShowVerticalBorder ( int )

virtual

Specify when and if the vertical border should appear.

virtual int vtkBorderRepresentation::GetShowVerticalBorder ( )

virtual

Specify when and if the vertical border should appear.

virtual void vtkBorderRepresentation::SetShowHorizontalBorder ( int )

virtual

Specify when and if the horizontal border should appear.

virtual int vtkBorderRepresentation::GetShowHorizontalBorder ( )

virtual

Specify when and if the horizontal border should appear.

virtual vtkProperty2D* vtkBorderRepresentation::GetBorderProperty ( )

virtual

Specify the properties of the border.

virtual void vtkBorderRepresentation::SetProportionalResize ( int )

virtual

Indicate whether resizing operations should keep the x-y directions proportional to one another.

Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.

virtual int vtkBorderRepresentation::GetProportionalResize ( )

virtual

Indicate whether resizing operations should keep the x-y directions proportional to one another.

Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.

virtual void vtkBorderRepresentation::ProportionalResizeOn ( )

virtual

Indicate whether resizing operations should keep the x-y directions proportional to one another.

Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.

virtual void vtkBorderRepresentation::ProportionalResizeOff ( )

virtual

Indicate whether resizing operations should keep the x-y directions proportional to one another.

Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.

virtual void vtkBorderRepresentation::SetMinimumSize	(	int	,
		int
	)

virtual

Specify a minimum and/or maximum size (in pixels) that this representation can take.