point representation constrained to a 2D plane More...

#include <vtkConstrainedPointHandleRepresentation.h>

Inheritance diagram for vtkConstrainedPointHandleRepresentation:

Collaboration diagram for vtkConstrainedPointHandleRepresentation:

Public Types
enum	{ XAxis =0, YAxis, ZAxis, Oblique }

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

void	SetProjectionNormalToYAxis ()

void	SetProjectionNormalToZAxis ()

void	SetProjectionNormalToOblique ()

int	CheckConstraint (vtkRenderer *renderer, double pos[2]) override
	Overridden from the base class. More...

void	SetDisplayPosition (double pos[3]) override
	Method overridden from Superclass. More...

void	Highlight (int highlight) override


void	SetCursorShape (vtkPolyData *cursorShape)
	Specify the cursor shape. More...

vtkPolyData *	GetCursorShape ()
	Specify the cursor shape. More...


void	SetActiveCursorShape (vtkPolyData *activeShape)
	Specify the shape of the cursor (handle) when it is active. More...

vtkPolyData *	GetActiveCursorShape ()
	Specify the shape of the cursor (handle) when it is active. More...


virtual void	SetProjectionNormal (int)
	Set the projection normal to lie along the x, y, or z axis, or to be oblique. More...

virtual int	GetProjectionNormal ()
	Set the projection normal to lie along the x, y, or z axis, or to be oblique. More...


void	SetObliquePlane (vtkPlane *)
	If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position. More...

virtual vtkPlane *	GetObliquePlane ()
	If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position. More...


void	SetProjectionPosition (double position)
	The position of the bounding plane from the origin along the normal. More...

virtual double	GetProjectionPosition ()
	The position of the bounding plane from the origin along the normal. More...


void	AddBoundingPlane (vtkPlane *plane)
	A collection of plane equations used to bound the position of the point. More...

void	RemoveBoundingPlane (vtkPlane *plane)
	A collection of plane equations used to bound the position of the point. More...

void	RemoveAllBoundingPlanes ()
	A collection of plane equations used to bound the position of the point. More...

virtual void	SetBoundingPlanes (vtkPlaneCollection *)
	A collection of plane equations used to bound the position of the point. More...

virtual vtkPlaneCollection *	GetBoundingPlanes ()
	A collection of plane equations used to bound the position of the point. More...

void	SetBoundingPlanes (vtkPlanes *planes)
	A collection of plane equations used to bound the position of the point. More...


void	SetPosition (double x, double y, double z)
	Set/Get the position of the point in display coordinates. More...

void	SetPosition (double xyz[3])
	Set/Get the position of the point in display coordinates. More...

double *	GetPosition ()
	Set/Get the position of the point in display coordinates. More...

void	GetPosition (double xyz[3])
	Set/Get the position of the point in display coordinates. More...


virtual vtkProperty *	GetProperty ()
	This is the property used when the handle is not active (the mouse is not near the handle) More...


virtual vtkProperty *	GetSelectedProperty ()
	This is the property used when the mouse is near the handle (but the user is not yet interacting with it) More...


virtual vtkProperty *	GetActiveProperty ()
	This is the property used when the user is interacting with the handle. More...


void	SetRenderer (vtkRenderer *ren) override
	Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods. More...

void	BuildRepresentation () override
	Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods. More...

void	StartWidgetInteraction (double eventPos[2]) override
	Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods. More...

void	WidgetInteraction (double eventPos[2]) override
	Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods. More...

int	ComputeInteractionState (int X, int Y, int modify) override
	Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods. More...


void	GetActors (vtkPropCollection *) override
	Methods to make this class behave as a vtkProp. More...

void	ReleaseGraphicsResources (vtkWindow *) override
	Methods to make this class behave as a vtkProp. More...

int	RenderOverlay (vtkViewport *viewport) override
	Methods to make this class behave as a vtkProp. More...

int	RenderOpaqueGeometry (vtkViewport *viewport) override
	Methods to make this class behave as a vtkProp. More...

int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
	Methods to make this class behave as a vtkProp. More...

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Methods to make this class behave as a vtkProp. More...

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

Public Member Functions inherited from vtkHandleRepresentation
vtkMTimeType	GetMTime () override
	Overload the superclasses' GetMTime() because the internal vtkCoordinates are used to keep the state of the representation. More...

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

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

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

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

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

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 ()
	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 void	SetActiveRepresentation (vtkTypeBool)
	Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active). More...

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

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

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

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

virtual void	SetConstrained (vtkTypeBool)
	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 vtkTypeBool	GetConstrained ()
	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 void	ConstrainedOn ()
	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 void	ConstrainedOff ()
	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...

void	ShallowCopy (vtkProp *prop) override
	Methods to make this class properly act like a vtkWidgetRepresentation. More...

virtual void	DeepCopy (vtkProp *prop)
	Methods to make this class properly act like a vtkWidgetRepresentation. More...

void	SetRenderer (vtkRenderer *ren) override
	Methods to make this class properly act like a vtkWidgetRepresentation. More...

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

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

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

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instances of this class. 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))

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

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

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

void	GetActors2D (vtkPropCollection *) override

void	GetVolumes (vtkPropCollection *) override

void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...

int	RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override

int	RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override

int	RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override

int	RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	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 void	RegisterPickers ()
	Register internal Pickers in the Picking Manager. More...

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

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

void	SetPickingManaged (bool managed)
	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 vtkRenderer *	GetRenderer ()
	Subclasses of vtkWidgetRepresentation must implement these methods. More...

virtual void	StartComplexInteraction (vtkRenderWindowInteractor , vtkAbstractWidget , unsigned long, void *)

virtual void	ComplexInteraction (vtkRenderWindowInteractor , vtkAbstractWidget , unsigned long, void *)

virtual void	EndComplexInteraction (vtkRenderWindowInteractor , vtkAbstractWidget , unsigned long, void *)

virtual int	ComputeComplexInteractionState (vtkRenderWindowInteractor iren, vtkAbstractWidget widget, unsigned long event, void *callData, int modify=0)

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 vtkTypeBool	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 (vtkTypeBool)
	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) override
	Standard methods for instances of this class. More...

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

void	PrintSelf (ostream &os, vtkIndent indent) override
	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	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers More...

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

virtual vtkTypeBool	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 (vtkTypeBool)
	Set/Get the pickable instance variable. More...

virtual vtkTypeBool	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 (vtkTypeBool)
	Set/Get the value of the dragable instance variable. More...

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

vtkTypeBool	HasObserver (unsigned long event)

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

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

vtkTypeBool	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 vtkConstrainedPointHandleRepresentation *	New ()
	Instantiate this class. More...

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

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

Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool	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 vtkTypeBool	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
	vtkConstrainedPointHandleRepresentation ()

	~vtkConstrainedPointHandleRepresentation () override

void	Translate (double eventPos[2])

void	Scale (double eventPos[2])

void	CreateDefaultProperties ()

int	GetIntersectionPosition (double eventPos[2], double worldPos[3], double tolerance=0.0, vtkRenderer *renderer=nullptr)

void	GetProjectionNormal (double normal[3])

void	GetProjectionOrigin (double origin[3])

Protected Member Functions inherited from vtkHandleRepresentation
	vtkHandleRepresentation ()

	~vtkHandleRepresentation () override

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation () override

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

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

vtkAssemblyPath *	GetAssemblyPath3DPoint (double pos[3], vtkAbstractPropPicker *picker)

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

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

void	UpdatePropPose (vtkProp3D prop, const double pos1, const double orient1, const double pos2, const double *orient2)

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. 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
vtkActor *	Actor

vtkPolyDataMapper *	Mapper

vtkGlyph3D *	Glypher

vtkPolyData *	CursorShape

vtkPolyData *	ActiveCursorShape

vtkPolyData *	FocalData

vtkPoints *	FocalPoint

double	LastPickPosition [3]

double	LastEventPosition [2]

vtkProperty *	Property

vtkProperty *	SelectedProperty

vtkProperty *	ActiveProperty

int	ProjectionNormal

double	ProjectionPosition

int	ProjectToPlane

vtkPlane *	ObliquePlane

vtkPlaneCollection *	BoundingPlanes

double	InteractionOffset [2]

Protected Attributes inherited from vtkHandleRepresentation
int	Tolerance

vtkTypeBool	ActiveRepresentation

vtkTypeBool	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

vtkTypeBool	NeedToRender

vtkTimeStamp	BuildTime

vtkNew< vtkTransform >	TempTransform

vtkNew< vtkMatrix4x4 >	TempMatrix

Protected Attributes inherited from vtkProp
vtkTypeBool	Visibility

vtkTypeBool	Pickable

vtkTypeBool	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 vtkHandleRepresentation	Superclass
	Standard methods for instances of this class. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instances of this class. More...

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

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instances of this class. More...

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

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

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instances of this class. More...

Detailed Description

point representation constrained to a 2D plane

This class is used to represent a vtkHandleWidget. It represents a position in 3D world coordinates that is constrained to a specified plane. The default look is to draw a white point when this widget is not selected or active, a thin green circle when it is highlighted, and a thicker cyan circle when it is active (being positioned). Defaults can be adjusted - but take care to define cursor geometry that makes sense for this widget. The geometry will be aligned on the constraining plane, with the plane normal aligned with the X axis of the geometry (similar behavior to vtkGlyph3D).

TODO: still need to work on 1) translation when mouse is outside bounding planes 2) size of the widget

See also: vtkHandleRepresentation vtkHandleWidget

Tests:: vtkConstrainedPointHandleRepresentation (Tests)

Definition at line 58 of file vtkConstrainedPointHandleRepresentation.h.

Member Typedef Documentation

typedef vtkHandleRepresentation vtkConstrainedPointHandleRepresentation::Superclass

Standard methods for instances of this class.

Definition at line 70 of file vtkConstrainedPointHandleRepresentation.h.

Member Enumeration Documentation

anonymous enum

Enumerator
XAxis
YAxis
ZAxis
Oblique

Definition at line 228 of file vtkConstrainedPointHandleRepresentation.h.

Constructor & Destructor Documentation

vtkConstrainedPointHandleRepresentation::vtkConstrainedPointHandleRepresentation ( )

protected

vtkConstrainedPointHandleRepresentation::~vtkConstrainedPointHandleRepresentation ( )

overrideprotected

Member Function Documentation

static vtkConstrainedPointHandleRepresentation* vtkConstrainedPointHandleRepresentation::New ( )

static

Instantiate this class.

static vtkTypeBool vtkConstrainedPointHandleRepresentation::IsTypeOf ( const char * type )

static

Standard methods for instances of this class.

virtual vtkTypeBool vtkConstrainedPointHandleRepresentation::IsA ( const char * type )

virtual

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

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

static

Standard methods for instances of this class.

virtual vtkObjectBase* vtkConstrainedPointHandleRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

vtkConstrainedPointHandleRepresentation* vtkConstrainedPointHandleRepresentation::NewInstance ( ) const

Standard methods for instances of this class.

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

overridevirtual

Standard methods for instances of this class.

Reimplemented from vtkObject.

void vtkConstrainedPointHandleRepresentation::SetCursorShape ( vtkPolyData * cursorShape )

Specify the cursor shape.

Keep in mind that the shape will be aligned with the constraining plane by orienting it such that the x axis of the geometry lies along the normal of the plane.

vtkPolyData* vtkConstrainedPointHandleRepresentation::GetCursorShape ( )

Specify the cursor shape.

Keep in mind that the shape will be aligned with the constraining plane by orienting it such that the x axis of the geometry lies along the normal of the plane.

void vtkConstrainedPointHandleRepresentation::SetActiveCursorShape ( vtkPolyData * activeShape )

Specify the shape of the cursor (handle) when it is active.

This is the geometry that will be used when the mouse is close to the handle or if the user is manipulating the handle.

vtkPolyData* vtkConstrainedPointHandleRepresentation::GetActiveCursorShape ( )

Specify the shape of the cursor (handle) when it is active.

This is the geometry that will be used when the mouse is close to the handle or if the user is manipulating the handle.

virtual void vtkConstrainedPointHandleRepresentation::SetProjectionNormal ( int )

virtual

Set the projection normal to lie along the x, y, or z axis, or to be oblique.

If it is oblique, then the plane is defined in the ObliquePlane ivar.

virtual int vtkConstrainedPointHandleRepresentation::GetProjectionNormal ( )

virtual

Set the projection normal to lie along the x, y, or z axis, or to be oblique.

If it is oblique, then the plane is defined in the ObliquePlane ivar.

void vtkConstrainedPointHandleRepresentation::SetProjectionNormalToXAxis ( )

inline

Definition at line 106 of file vtkConstrainedPointHandleRepresentation.h.

void vtkConstrainedPointHandleRepresentation::SetProjectionNormalToYAxis ( )

inline

Definition at line 108 of file vtkConstrainedPointHandleRepresentation.h.

void vtkConstrainedPointHandleRepresentation::SetProjectionNormalToZAxis ( )

inline

Definition at line 110 of file vtkConstrainedPointHandleRepresentation.h.

void vtkConstrainedPointHandleRepresentation::SetProjectionNormalToOblique ( )

inline

Definition at line 112 of file vtkConstrainedPointHandleRepresentation.h.

void vtkConstrainedPointHandleRepresentation::SetObliquePlane ( vtkPlane * )

If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position.

virtual vtkPlane* vtkConstrainedPointHandleRepresentation::GetObliquePlane ( )

virtual

If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position.

void vtkConstrainedPointHandleRepresentation::SetProjectionPosition ( double position )

The position of the bounding plane from the origin along the normal.

The origin and normal are defined in the oblique plane when the ProjectionNormal is Oblique. For the X, Y, and Z axes projection normals, the normal is the axis direction, and the origin is (0,0,0).

virtual double vtkConstrainedPointHandleRepresentation::GetProjectionPosition ( )

virtual

The position of the bounding plane from the origin along the normal.

The origin and normal are defined in the oblique plane when the ProjectionNormal is Oblique. For the X, Y, and Z axes projection normals, the normal is the axis direction, and the origin is (0,0,0).

void vtkConstrainedPointHandleRepresentation::AddBoundingPlane ( vtkPlane * plane )

A collection of plane equations used to bound the position of the point.

This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

void vtkConstrainedPointHandleRepresentation::RemoveBoundingPlane ( vtkPlane * plane )

A collection of plane equations used to bound the position of the point.

This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

void vtkConstrainedPointHandleRepresentation::RemoveAllBoundingPlanes ( )

A collection of plane equations used to bound the position of the point.

This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

virtual void vtkConstrainedPointHandleRepresentation::SetBoundingPlanes ( vtkPlaneCollection * )

virtual

A collection of plane equations used to bound the position of the point.

This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

virtual vtkPlaneCollection* vtkConstrainedPointHandleRepresentation::GetBoundingPlanes ( )

virtual

A collection of plane equations used to bound the position of the point.

This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

void vtkConstrainedPointHandleRepresentation::SetBoundingPlanes ( vtkPlanes * planes )

A collection of plane equations used to bound the position of the point.

This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

int vtkConstrainedPointHandleRepresentation::CheckConstraint	(	vtkRenderer *	renderer,
		double	pos[2]
	)

overridevirtual

Overridden from the base class.

It converts the display co-ordinates to world co-ordinates. It returns 1 if the point lies within the constrained region, otherwise return 0

Reimplemented from vtkHandleRepresentation.

void vtkConstrainedPointHandleRepresentation::SetPosition	(	double	x,
		double	y,
		double	z
	)

Set/Get the position of the point in display coordinates.

These are convenience methods that extend the superclasses' GetHandlePosition() method. Note that only the x-y coordinate values are used

void vtkConstrainedPointHandleRepresentation::SetPosition ( double xyz[3] )

Set/Get the position of the point in display coordinates.

These are convenience methods that extend the superclasses' GetHandlePosition() method. Note that only the x-y coordinate values are used

double* vtkConstrainedPointHandleRepresentation::GetPosition ( )

Set/Get the position of the point in display coordinates.

These are convenience methods that extend the superclasses' GetHandlePosition() method. Note that only the x-y coordinate values are used

void vtkConstrainedPointHandleRepresentation::GetPosition ( double xyz[3] )

Set/Get the position of the point in display coordinates.

These are convenience methods that extend the superclasses' GetHandlePosition() method. Note that only the x-y coordinate values are used

virtual vtkProperty* vtkConstrainedPointHandleRepresentation::GetProperty ( )

virtual

This is the property used when the handle is not active (the mouse is not near the handle)

virtual vtkProperty* vtkConstrainedPointHandleRepresentation::GetSelectedProperty ( )

virtual

This is the property used when the mouse is near the handle (but the user is not yet interacting with it)

virtual vtkProperty* vtkConstrainedPointHandleRepresentation::GetActiveProperty ( )

virtual

This is the property used when the user is interacting with the handle.

void vtkConstrainedPointHandleRepresentation::SetRenderer ( vtkRenderer * ren )

overridevirtual

Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods.

These are the methods that the widget and its representation use to communicate with each other.

Reimplemented from vtkWidgetRepresentation.

void vtkConstrainedPointHandleRepresentation::BuildRepresentation ( )

overridevirtual

Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods.

These are the methods that the widget and its representation use to communicate with each other.

Implements vtkWidgetRepresentation.

void vtkConstrainedPointHandleRepresentation::StartWidgetInteraction ( double eventPos[2] )

overridevirtual

Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods.

These are the methods that the widget and its representation use to communicate with each other.

Reimplemented from vtkWidgetRepresentation.

void vtkConstrainedPointHandleRepresentation::WidgetInteraction ( double eventPos[2] )

overridevirtual

Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods.

These are the methods that the widget and its representation use to communicate with each other.

Reimplemented from vtkWidgetRepresentation.

int vtkConstrainedPointHandleRepresentation::ComputeInteractionState	(	int	X,
		int	Y,
		int	modify
	)

overridevirtual

Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods.

These are the methods that the widget and its representation use to communicate with each other.

Reimplemented from vtkWidgetRepresentation.

void vtkConstrainedPointHandleRepresentation::SetDisplayPosition ( double pos[3] )

overridevirtual

Method overridden from Superclass.

computes the world co-ordinates using GetIntersectionPosition()

Reimplemented from vtkHandleRepresentation.

void vtkConstrainedPointHandleRepresentation::GetActors ( vtkPropCollection * )

overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

void vtkConstrainedPointHandleRepresentation::ReleaseGraphicsResources ( vtkWindow * )

overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

int vtkConstrainedPointHandleRepresentation::RenderOverlay ( vtkViewport * viewport )

overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

int vtkConstrainedPointHandleRepresentation::RenderOpaqueGeometry ( vtkViewport * viewport )

overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

int vtkConstrainedPointHandleRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport * viewport )

overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

vtkTypeBool vtkConstrainedPointHandleRepresentation::HasTranslucentPolygonalGeometry ( )

overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

void vtkConstrainedPointHandleRepresentation::ShallowCopy ( vtkProp * prop )

overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

void vtkConstrainedPointHandleRepresentation::Highlight ( int highlight )

override

void vtkConstrainedPointHandleRepresentation::Translate ( double eventPos[2] )

protected

void vtkConstrainedPointHandleRepresentation::Scale ( double eventPos[2] )

protected

void vtkConstrainedPointHandleRepresentation::CreateDefaultProperties ( )

protected

int vtkConstrainedPointHandleRepresentation::GetIntersectionPosition	(	double	eventPos[2],
		double	worldPos[3],
		double	tolerance = `0.0`,
		vtkRenderer *	renderer = `nullptr`
	)