represent a user defined handle geometry in 3D while maintaining a fixed orientation w.r.t the camera. More...

#include <vtkAbstractPolygonalHandleRepresentation3D.h>

Inheritance diagram for vtkAbstractPolygonalHandleRepresentation3D:

Collaboration diagram for vtkAbstractPolygonalHandleRepresentation3D:

Public Types
typedef vtkHandleRepresentation	Superclass
	Standard methods for instances of this class. More...

Public Types inherited from vtkHandleRepresentation
enum	_InteractionState { Outside =0, Nearby, Selecting, Translating, Scaling }

typedef vtkWidgetRepresentation	Superclass
	Standard methods for instances of this class. 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 int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkAbstractPolygonalHandleRepresentation3D *	NewInstance () const

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

virtual void	SetWorldPosition (double p[3])
	Set the position of the point in world and display coordinates. More...

virtual void	SetDisplayPosition (double p[3])
	Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates. More...

void	SetHandle (vtkPolyData *)
	Set/get the handle polydata. More...

vtkPolyData *	GetHandle ()

void	SetProperty (vtkProperty *)
	Set/Get the handle properties when unselected and selected. More...

void	SetSelectedProperty (vtkProperty *)

virtual vtkProperty *	GetProperty ()

virtual vtkProperty *	GetSelectedProperty ()

virtual vtkAbstractTransform *	GetTransform ()
	Get the transform used to transform the generic handle polydata before placing it in the render window. More...

virtual void	BuildRepresentation ()
	Methods to make this class properly act like a vtkWidgetRepresentation. More...

virtual void	StartWidgetInteraction (double eventPos[2])

virtual void	WidgetInteraction (double eventPos[2])

virtual int	ComputeInteractionState (int X, int Y, int modify=0)

virtual void	ShallowCopy (vtkProp *prop)
	Methods to make this class behave as a vtkProp. More...

virtual void	DeepCopy (vtkProp *prop)

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	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...

virtual int	RenderOpaqueGeometry (vtkViewport *viewport)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. More...

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport)

virtual int	HasTranslucentPolygonalGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More...

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

virtual void	SetLabelVisibility (int)
	A label may be associated with the seed. More...

virtual int	GetLabelVisibility ()

virtual void	LabelVisibilityOn ()

virtual void	LabelVisibilityOff ()

virtual void	SetLabelText (const char *label)

virtual char *	GetLabelText ()

virtual void	SetLabelTextScale (double scale[3])
	Scale text (font size along each dimension). More...

void	SetLabelTextScale (double x, double y, double z)

virtual double *	GetLabelTextScale ()

virtual vtkFollower *	GetLabelTextActor ()
	Get the label text actor. More...

virtual void	SetUniformScale (double scale)
	The handle may be scaled uniformly in all three dimensions using this API. More...

virtual void	SetHandleVisibility (int)
	Toogle the visibility of the handle on and off. More...

virtual int	GetHandleVisibility ()

virtual void	HandleVisibilityOn ()

virtual void	HandleVisibilityOff ()

void	Highlight (int highlight)

virtual void	SetSmoothMotion (int)
	Turn on/off smooth motion of the handle. More...

virtual int	GetSmoothMotion ()

virtual void	SmoothMotionOn ()

virtual void	SmoothMotionOff ()

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

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

virtual void	GetDisplayPosition (double pos[3])

virtual double *	GetDisplayPosition ()

virtual void	GetWorldPosition (double pos[3])

virtual double *	GetWorldPosition ()

virtual void	SetTolerance (int)
	The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the widget to be active. More...

virtual int	GetTolerance ()

virtual void	SetActiveRepresentation (int)
	Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active). More...

virtual int	GetActiveRepresentation ()

virtual void	ActiveRepresentationOn ()

virtual void	ActiveRepresentationOff ()

virtual void	SetInteractionState (int)
	The interaction state may be set from a widget (e.g., HandleWidget) or other object. More...

virtual void	SetConstrained (int)
	Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion. More...

virtual int	GetConstrained ()

virtual void	ConstrainedOn ()

virtual void	ConstrainedOff ()

virtual int	CheckConstraint (vtkRenderer *renderer, double pos[2])
	Method has to be overridden in the subclasses which has constraints on placing the handle (Ex. More...

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

virtual vtkMTimeType	GetMTime ()
	Overload the superclasses' GetMTime() because the internal vtkCoordinates are used to keep the state of the representation. More...

virtual void	SetPointPlacer (vtkPointPlacer *)
	Set/Get the point placer. More...

virtual vtkPointPlacer *	GetPointPlacer ()

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

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

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

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool)

virtual bool	GetPickingManaged ()

virtual vtkRenderer *	GetRenderer ()

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 void	SetPlaceFactor (double)
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...

virtual double	GetPlaceFactor ()

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

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)

virtual void	NeedToRenderOn ()

virtual void	NeedToRenderOff ()

virtual void	GetActors2D (vtkPropCollection *)

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

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	SetVisibility (int)
	Set/Get visibility of this vtkProp. More...

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

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

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

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

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

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently. 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 ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

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

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

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 vtkInformation *	GetPropertyKeys ()
	Set/Get property keys. More...

virtual void	SetPropertyKeys (vtkInformation *keys)

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

virtual int	RenderVolumetricGeometry (vtkViewport *)

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

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

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

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

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

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)

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)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

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

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

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

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

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

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

void	InitializeObjectBase ()

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

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

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

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

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

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

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

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

static vtkAbstractPolygonalHandleRepresentation3D *	SafeDownCast (vtkObjectBase *o)

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

static vtkHandleRepresentation *	SafeDownCast (vtkObjectBase *o)

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

static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)

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

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractPolygonalHandleRepresentation3D ()

	~vtkAbstractPolygonalHandleRepresentation3D ()

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

virtual void	Translate (double p1, double p2)

virtual void	Scale (double p1, double p2, double eventPos[2])

virtual void	MoveFocus (double p1, double p2)

void	CreateDefaultProperties ()

void	MoveFocusRequest (double p1, double p2, double eventPos[2], double requestedDisplayPos[3])

int	DetermineConstraintAxis (int constraint, double x, double startPickPos)

virtual void	UpdateHandle ()
	Update the actor position. More...

virtual void	UpdateLabel ()
	Opportunity to update the label position and text during each render. More...

Protected Member Functions inherited from vtkHandleRepresentation
	vtkHandleRepresentation ()

	~vtkHandleRepresentation ()

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation ()

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

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

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
vtkActor *	Actor

vtkPolyDataMapper *	Mapper

vtkTransformPolyDataFilter *	HandleTransformFilter

vtkMatrixToLinearTransform *	HandleTransform

vtkMatrix4x4 *	HandleTransformMatrix

vtkCellPicker *	HandlePicker

double	LastPickPosition [3]

double	LastEventPosition [2]

int	ConstraintAxis

vtkProperty *	Property

vtkProperty *	SelectedProperty

int	WaitingForMotion

int	WaitCount

int	HandleVisibility

int	LabelVisibility

vtkFollower *	LabelTextActor

vtkPolyDataMapper *	LabelTextMapper

vtkVectorText *	LabelTextInput

bool	LabelAnnotationTextScaleInitialized

int	SmoothMotion

Protected Attributes inherited from vtkHandleRepresentation
int	Tolerance

int	ActiveRepresentation

int	Constrained

vtkCoordinate *	DisplayPosition

vtkCoordinate *	WorldPosition

vtkTimeStamp	DisplayPositionTime

vtkTimeStamp	WorldPositionTime

vtkPointPlacer *	PointPlacer

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

Detailed Description

represent a user defined handle geometry in 3D while maintaining a fixed orientation w.r.t the camera.

This class serves as the geometrical representation of a vtkHandleWidget. The handle can be represented by an arbitrary polygonal data (vtkPolyData), set via SetHandle(vtkPolyData *). The actual position of the handle will be initially assumed to be (0,0,0). You can specify an offset from this position if desired. This class differs from vtkPolygonalHandleRepresentation3D in that the handle will always remain front facing, ie it maintains a fixed orientation with respect to the camera. This is done by using vtkFollowers internally to render the actors.

See also: vtkPolygonalHandleRepresentation3D vtkHandleRepresentation vtkHandleWidget

Tests:: vtkAbstractPolygonalHandleRepresentation3D (Tests)

Definition at line 52 of file vtkAbstractPolygonalHandleRepresentation3D.h.

Member Typedef Documentation

◆ Superclass

typedef vtkHandleRepresentation vtkAbstractPolygonalHandleRepresentation3D::Superclass

Standard methods for instances of this class.

Definition at line 61 of file vtkAbstractPolygonalHandleRepresentation3D.h.

Constructor & Destructor Documentation

◆ vtkAbstractPolygonalHandleRepresentation3D()

vtkAbstractPolygonalHandleRepresentation3D::vtkAbstractPolygonalHandleRepresentation3D ( )

protected

◆ ~vtkAbstractPolygonalHandleRepresentation3D()

vtkAbstractPolygonalHandleRepresentation3D::~vtkAbstractPolygonalHandleRepresentation3D ( )

protected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual int vtkAbstractPolygonalHandleRepresentation3D::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 vtkHandleRepresentation.

Reimplemented in vtkPolygonalHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkFixedSizeHandleRepresentation3D.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractPolygonalHandleRepresentation3D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkPolygonalHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkFixedSizeHandleRepresentation3D.

◆ NewInstance()

vtkAbstractPolygonalHandleRepresentation3D* vtkAbstractPolygonalHandleRepresentation3D::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractPolygonalHandleRepresentation3D::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.

Reimplemented in vtkPolygonalHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkFixedSizeHandleRepresentation3D.

◆ SetWorldPosition()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetWorldPosition ( double p[3] )

virtual

Set the position of the point in world and display coordinates.

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkPolygonalHandleRepresentation3D.

◆ SetDisplayPosition()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetDisplayPosition ( double pos[3] )

virtual

Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.

(Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.

Reimplemented from vtkHandleRepresentation.

◆ SetHandle()

void vtkAbstractPolygonalHandleRepresentation3D::SetHandle ( vtkPolyData * )

Set/get the handle polydata.

◆ GetHandle()

vtkPolyData* vtkAbstractPolygonalHandleRepresentation3D::GetHandle ( )

◆ SetProperty()

void vtkAbstractPolygonalHandleRepresentation3D::SetProperty ( vtkProperty * )

Set/Get the handle properties when unselected and selected.

◆ SetSelectedProperty()

void vtkAbstractPolygonalHandleRepresentation3D::SetSelectedProperty ( vtkProperty * )

◆ GetProperty()

virtual vtkProperty* vtkAbstractPolygonalHandleRepresentation3D::GetProperty ( )

virtual

◆ GetSelectedProperty()

virtual vtkProperty* vtkAbstractPolygonalHandleRepresentation3D::GetSelectedProperty ( )

virtual

◆ GetTransform()

virtual vtkAbstractTransform* vtkAbstractPolygonalHandleRepresentation3D::GetTransform ( )

virtual

Get the transform used to transform the generic handle polydata before placing it in the render window.

◆ BuildRepresentation()

virtual void vtkAbstractPolygonalHandleRepresentation3D::BuildRepresentation ( )

virtual

Methods to make this class properly act like a vtkWidgetRepresentation.

Implements vtkWidgetRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D.

◆ StartWidgetInteraction()

virtual void vtkAbstractPolygonalHandleRepresentation3D::StartWidgetInteraction ( double eventPos[2] )

virtual

Reimplemented from vtkWidgetRepresentation.

◆ WidgetInteraction()

virtual void vtkAbstractPolygonalHandleRepresentation3D::WidgetInteraction ( double eventPos[2] )

virtual

Reimplemented from vtkWidgetRepresentation.

◆ ComputeInteractionState()

virtual int vtkAbstractPolygonalHandleRepresentation3D::ComputeInteractionState	(	int	X,
		int	Y,
		int	modify = `0`
	)

virtual

Reimplemented from vtkWidgetRepresentation.

◆ ShallowCopy()

virtual void vtkAbstractPolygonalHandleRepresentation3D::ShallowCopy ( vtkProp * prop )

virtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkHandleRepresentation.

◆ DeepCopy()

virtual void vtkAbstractPolygonalHandleRepresentation3D::DeepCopy ( vtkProp * prop )

virtual

Reimplemented from vtkHandleRepresentation.

◆ GetActors()

virtual void vtkAbstractPolygonalHandleRepresentation3D::GetActors ( vtkPropCollection * )

virtual

For some exporters and other other operations we must be able to collect all the actors or volumes.

These methods are used in that process.

Reimplemented from vtkWidgetRepresentation.

◆ ReleaseGraphicsResources()

virtual void vtkAbstractPolygonalHandleRepresentation3D::ReleaseGraphicsResources ( vtkWindow * )

virtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkWidgetRepresentation.

◆ RenderOpaqueGeometry()

virtual int vtkAbstractPolygonalHandleRepresentation3D::RenderOpaqueGeometry ( vtkViewport * )

virtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.

There are four key render methods in vtk and they correspond to four different points in the rendering cycle. Any given prop may implement one or more of these methods. The first method is intended for rendering all opaque geometry. The second method is intended for rendering all translucent polygonal geometry. The third one is intended for rendering all translucent volumetric geometry. Most of the volume rendering mappers draw their results during this third method. The last method is to render any 2D annotation or overlays. Each of these methods return an integer value indicating whether or not this render method was applied to this data.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

virtual int vtkAbstractPolygonalHandleRepresentation3D::RenderTranslucentPolygonalGeometry ( vtkViewport * viewport )

virtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

virtual int vtkAbstractPolygonalHandleRepresentation3D::HasTranslucentPolygonalGeometry ( )

virtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.

A simple prop that has some translucent polygonal geometry will return true. A composite prop (like vtkAssembly) that has at least one sub-prop that has some translucent polygonal geometry will return true. Default implementation return false.

Reimplemented from vtkWidgetRepresentation.

◆ GetBounds()

virtual double* vtkAbstractPolygonalHandleRepresentation3D::GetBounds ( void )

virtual

Methods to make this class behave as a vtkProp.

They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).

Reimplemented from vtkWidgetRepresentation.

◆ SetLabelVisibility()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetLabelVisibility ( int )

virtual

A label may be associated with the seed.

The string can be set via SetLabelText. The visibility of the label can be turned on / off.

◆ GetLabelVisibility()

virtual int vtkAbstractPolygonalHandleRepresentation3D::GetLabelVisibility ( )

virtual

◆ LabelVisibilityOn()

virtual void vtkAbstractPolygonalHandleRepresentation3D::LabelVisibilityOn ( )

virtual

◆ LabelVisibilityOff()

virtual void vtkAbstractPolygonalHandleRepresentation3D::LabelVisibilityOff ( )

virtual

◆ SetLabelText()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetLabelText ( const char * label )

virtual

◆ GetLabelText()

virtual char* vtkAbstractPolygonalHandleRepresentation3D::GetLabelText ( )

virtual

◆ SetLabelTextScale() [1/2]

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetLabelTextScale ( double scale[3] )

virtual

Scale text (font size along each dimension).

◆ SetLabelTextScale() [2/2]

void vtkAbstractPolygonalHandleRepresentation3D::SetLabelTextScale	(	double	x,
		double	y,
		double	z
	)

inline

Definition at line 138 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ GetLabelTextScale()

virtual double* vtkAbstractPolygonalHandleRepresentation3D::GetLabelTextScale ( )

virtual

◆ GetLabelTextActor()

virtual vtkFollower* vtkAbstractPolygonalHandleRepresentation3D::GetLabelTextActor ( )

virtual

Get the label text actor.

◆ SetUniformScale()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetUniformScale ( double scale )

virtual

The handle may be scaled uniformly in all three dimensions using this API.

The handle can also be scaled interactively using the right mouse button.

◆ SetHandleVisibility()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetHandleVisibility ( int )

virtual

Toogle the visibility of the handle on and off.

◆ GetHandleVisibility()

virtual int vtkAbstractPolygonalHandleRepresentation3D::GetHandleVisibility ( )

virtual

◆ HandleVisibilityOn()

virtual void vtkAbstractPolygonalHandleRepresentation3D::HandleVisibilityOn ( )

virtual

◆ HandleVisibilityOff()

virtual void vtkAbstractPolygonalHandleRepresentation3D::HandleVisibilityOff ( )

virtual

◆ Highlight()

void vtkAbstractPolygonalHandleRepresentation3D::Highlight ( int highlight )

◆ SetSmoothMotion()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetSmoothMotion ( int )

virtual

Turn on/off smooth motion of the handle.

See the documentation of MoveFocusRequest for details. By default, SmoothMotion is ON. However, in certain applications the user may want to turn it off. For instance when using certain specific PointPlacer's with the representation such as the vtkCellCentersPointPlacer, which causes the representation to snap to the center of cells, or using a vtkPolygonalSurfacePointPlacer which constrains the widget to the surface of a mesh. In such cases, inherent restrictions on handle placement might conflict with a request for smooth motion of the handles.

◆ GetSmoothMotion()

virtual int vtkAbstractPolygonalHandleRepresentation3D::GetSmoothMotion ( )

virtual

◆ SmoothMotionOn()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SmoothMotionOn ( )

virtual

◆ SmoothMotionOff()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SmoothMotionOff ( )

virtual

◆ RegisterPickers()

virtual void vtkAbstractPolygonalHandleRepresentation3D::RegisterPickers ( )

protectedvirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widget representations to register their pickers.

Reimplemented from vtkWidgetRepresentation.

◆ Translate()

virtual void vtkAbstractPolygonalHandleRepresentation3D::Translate	(	double *	p1,
		double *	p2
	)

protectedvirtual

◆ Scale()

virtual void vtkAbstractPolygonalHandleRepresentation3D::Scale	(	double *	p1,
		double *	p2,
		double	eventPos[2]
	)

protectedvirtual

◆ MoveFocus()

virtual void vtkAbstractPolygonalHandleRepresentation3D::MoveFocus	(	double *	p1,
		double *	p2
	)

protectedvirtual

◆ CreateDefaultProperties()

void vtkAbstractPolygonalHandleRepresentation3D::CreateDefaultProperties ( )

protected

◆ MoveFocusRequest()

void vtkAbstractPolygonalHandleRepresentation3D::MoveFocusRequest	(	double *	p1,
		double *	p2,
		double	eventPos[2],
		double	requestedDisplayPos[3]
	)

protected

◆ DetermineConstraintAxis()

int vtkAbstractPolygonalHandleRepresentation3D::DetermineConstraintAxis	(	int	constraint,
		double *	x,
		double *	startPickPos
	)

protected

◆ UpdateHandle()

virtual void vtkAbstractPolygonalHandleRepresentation3D::UpdateHandle ( )

protectedvirtual

Update the actor position.

Different subclasses handle this differently. For instance vtkPolygonalHandleRepresentation3D updates the handle transformation and sets this on the handle. vtkOrientedPolygonalHandleRepresentation3D, which uses a vtkFollower to keep the handle geometry facinig the camera handles this differently. This is an opportunity for subclasses to update the actor's position etc each time the handle is rendered.

Reimplemented in vtkOrientedPolygonalHandleRepresentation3D.

◆ UpdateLabel()

virtual void vtkAbstractPolygonalHandleRepresentation3D::UpdateLabel ( )

protectedvirtual

Opportunity to update the label position and text during each render.

Member Data Documentation

◆ Actor

vtkActor* vtkAbstractPolygonalHandleRepresentation3D::Actor

protected

Definition at line 192 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ Mapper

vtkPolyDataMapper* vtkAbstractPolygonalHandleRepresentation3D::Mapper

protected

Definition at line 193 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ HandleTransformFilter

vtkTransformPolyDataFilter* vtkAbstractPolygonalHandleRepresentation3D::HandleTransformFilter

protected

Definition at line 194 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ HandleTransform

vtkMatrixToLinearTransform* vtkAbstractPolygonalHandleRepresentation3D::HandleTransform

protected

Definition at line 195 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ HandleTransformMatrix

vtkMatrix4x4* vtkAbstractPolygonalHandleRepresentation3D::HandleTransformMatrix

protected

Definition at line 196 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ HandlePicker

vtkCellPicker* vtkAbstractPolygonalHandleRepresentation3D::HandlePicker

protected

Definition at line 197 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ LastPickPosition

double vtkAbstractPolygonalHandleRepresentation3D::LastPickPosition[3]

protected

Definition at line 198 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ LastEventPosition

double vtkAbstractPolygonalHandleRepresentation3D::LastEventPosition[2]

protected

Definition at line 199 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ ConstraintAxis

int vtkAbstractPolygonalHandleRepresentation3D::ConstraintAxis

protected

Definition at line 200 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ Property

vtkProperty* vtkAbstractPolygonalHandleRepresentation3D::Property

protected

Definition at line 201 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ SelectedProperty

vtkProperty* vtkAbstractPolygonalHandleRepresentation3D::SelectedProperty

protected

Definition at line 202 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ WaitingForMotion

int vtkAbstractPolygonalHandleRepresentation3D::WaitingForMotion

protected

Definition at line 203 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ WaitCount

int vtkAbstractPolygonalHandleRepresentation3D::WaitCount

protected

Definition at line 204 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ HandleVisibility

int vtkAbstractPolygonalHandleRepresentation3D::HandleVisibility

protected

Definition at line 205 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ LabelVisibility

int vtkAbstractPolygonalHandleRepresentation3D::LabelVisibility

protected

Definition at line 248 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ LabelTextActor

vtkFollower* vtkAbstractPolygonalHandleRepresentation3D::LabelTextActor

protected

Definition at line 249 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ LabelTextMapper

vtkPolyDataMapper* vtkAbstractPolygonalHandleRepresentation3D::LabelTextMapper

protected

Definition at line 250 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ LabelTextInput

vtkVectorText* vtkAbstractPolygonalHandleRepresentation3D::LabelTextInput

protected

Definition at line 251 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ LabelAnnotationTextScaleInitialized

bool vtkAbstractPolygonalHandleRepresentation3D::LabelAnnotationTextScaleInitialized

protected

Definition at line 252 of file vtkAbstractPolygonalHandleRepresentation3D.h.

◆ SmoothMotion

int vtkAbstractPolygonalHandleRepresentation3D::SmoothMotion

protected

Definition at line 253 of file vtkAbstractPolygonalHandleRepresentation3D.h.

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

dox/Interaction/Widgets/vtkAbstractPolygonalHandleRepresentation3D.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkAbstractPolygonalHandleRepresentation3D()

◆ ~vtkAbstractPolygonalHandleRepresentation3D()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetWorldPosition()

◆ SetDisplayPosition()

◆ SetHandle()

◆ GetHandle()

◆ SetProperty()

◆ SetSelectedProperty()

◆ GetProperty()

◆ GetSelectedProperty()

◆ GetTransform()

◆ BuildRepresentation()

◆ StartWidgetInteraction()

◆ WidgetInteraction()

◆ ComputeInteractionState()

◆ ShallowCopy()

◆ DeepCopy()

◆ GetActors()

◆ ReleaseGraphicsResources()

◆ RenderOpaqueGeometry()

◆ RenderTranslucentPolygonalGeometry()

◆ HasTranslucentPolygonalGeometry()

◆ GetBounds()

◆ SetLabelVisibility()

◆ GetLabelVisibility()

◆ LabelVisibilityOn()

◆ LabelVisibilityOff()

◆ SetLabelText()

◆ GetLabelText()

◆ SetLabelTextScale() [1/2]

◆ SetLabelTextScale() [2/2]

◆ GetLabelTextScale()

◆ GetLabelTextActor()

◆ SetUniformScale()

◆ SetHandleVisibility()

◆ GetHandleVisibility()

◆ HandleVisibilityOn()

◆ HandleVisibilityOff()

◆ Highlight()

◆ SetSmoothMotion()

◆ GetSmoothMotion()

◆ SmoothMotionOn()

◆ SmoothMotionOff()

◆ RegisterPickers()

◆ Translate()

◆ Scale()

◆ MoveFocus()

◆ CreateDefaultProperties()

◆ MoveFocusRequest()

◆ DetermineConstraintAxis()

◆ UpdateHandle()

◆ UpdateLabel()

Member Data Documentation

◆ Actor

◆ Mapper

◆ HandleTransformFilter

◆ HandleTransform

◆ HandleTransformMatrix

◆ HandlePicker

◆ LastPickPosition

◆ LastEventPosition

◆ ConstraintAxis

◆ Property

◆ SelectedProperty