vtkPointHandleRepresentation2D Class Reference

represent the position of a point in display coordinates More...

#include <vtkPointHandleRepresentation2D.h>

Inheritance diagram for vtkPointHandleRepresentation2D:

Collaboration diagram for vtkPointHandleRepresentation2D:

Public Member Functions
void	SetDisplayPosition (double xyz[3]) override
	Set/Get the position of the point in display coordinates.
void	Highlight (int highlight) override
void	SetPointPlacer (vtkPointPlacer *) override
	Override the superclass implementation.
void	SetVisibility (vtkTypeBool visible) override
	Override to ensure that the internal actor's visibility is consistent with this representation's visibility.
virtual void	Translate (const double *p1, const double *p2)
	Translates world position by vector p1p2 projected on the constraint axis if any.
virtual void	Translate (const double *v)
	Translates world position by vector v projected on the constraint axis if any.
void	SetCursorShape (vtkPolyData *cursorShape)
	Specify the cursor shape with an instance of vtkPolyData.
vtkPolyData *	GetCursorShape ()
	Specify the cursor shape with an instance of vtkPolyData.
void	SetProperty (vtkProperty2D *)
	Set/Get the handle properties when unselected and selected.
void	SetSelectedProperty (vtkProperty2D *)
	Set/Get the handle properties when unselected and selected.
virtual vtkProperty2D *	GetProperty ()
	Set/Get the handle properties when unselected and selected.
virtual vtkProperty2D *	GetSelectedProperty ()
	Set/Get the handle properties when unselected and selected.
double *	GetBounds () override
	Subclasses of vtkPointHandleRepresentation2D must implement these methods.
void	BuildRepresentation () override
	Subclasses of vtkPointHandleRepresentation2D must implement these methods.
void	StartWidgetInteraction (double eventPos[2]) override
	Subclasses of vtkPointHandleRepresentation2D must implement these methods.
void	WidgetInteraction (double eventPos[2]) override
	Subclasses of vtkPointHandleRepresentation2D must implement these methods.
int	ComputeInteractionState (int X, int Y, int modify=0) override
	Subclasses of vtkPointHandleRepresentation2D must implement these methods.
void	ShallowCopy (vtkProp *prop) override
	Methods to make this class behave as a vtkProp.
void	DeepCopy (vtkProp *prop) override
	Methods to make this class behave as a vtkProp.
void	GetActors2D (vtkPropCollection *) override
	Methods to make this class behave as a vtkProp.
void	ReleaseGraphicsResources (vtkWindow *) override
	Methods to make this class behave as a vtkProp.
int	RenderOverlay (vtkViewport *viewport) override
	Methods to make this class behave as a vtkProp.
Public Member Functions inherited from vtkHandleRepresentation
virtual int	CheckConstraint (vtkRenderer *renderer, double pos[2])
	Method has to be overridden in the subclasses which has constraints on placing the handle (Ex.
vtkMTimeType	GetMTime () override
	Overload the superclasses' GetMTime() because the internal vtkCoordinates are used to keep the state of the representation.
virtual void	SetDisplayPosition (double pos[2])
	Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.
virtual void	GetDisplayPosition (double pos[2])
	Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.
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.
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.
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.
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.
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.
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.
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).
virtual vtkTypeBool	GetActiveRepresentation ()
	Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active).
virtual void	ActiveRepresentationOn ()
	Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active).
virtual void	ActiveRepresentationOff ()
	Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active).
virtual void	SetInteractionState (int)
	The interaction state may be set from a widget (e.g., HandleWidget) or other object.
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.
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.
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.
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.
void	SetRenderer (vtkRenderer *ren) override
	Methods to make this class properly act like a vtkWidgetRepresentation.
virtual vtkPointPlacer *	GetPointPlacer ()
	Set/Get the point placer.
virtual void	GetTranslationVector (const double *p1, const double *p2, double *v) const
	Gets the translation vector.
virtual int	GetTranslationAxis ()
	Gets/Sets the constraint axis for translations.
virtual void	SetTranslationAxis (int)
	Gets/Sets the constraint axis for translations.
void	SetXTranslationAxisOn ()
	Toggles constraint translation axis on/off.
void	SetYTranslationAxisOn ()
	Toggles constraint translation axis on/off.
void	SetZTranslationAxisOn ()
	Toggles constraint translation axis on/off.
void	SetCustomTranslationAxisOn ()
	Toggles constraint translation axis on/off.
void	SetTranslationAxisOff ()
	Toggles constraint translation axis on/off.
virtual double *	GetCustomTranslationAxis ()
	Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.
virtual void	GetCustomTranslationAxis (double &, double &, double &)
	Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.
virtual void	GetCustomTranslationAxis (double[3])
	Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.
virtual void	SetCustomTranslationAxis (double, double, double)
	Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.
virtual void	SetCustomTranslationAxis (double[3])
	Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.
bool	IsTranslationConstrained ()
	Returns true if ConstrainedAxis.
vtkHandleRepresentation *	NewInstance () const
	Standard methods for instances of this class.
Public Member Functions inherited from vtkWidgetRepresentation
virtual void	PlaceWidget (double vtkNotUsed(bounds)[6])
	The following is a suggested API for widget representations.
virtual void	StartWidgetInteraction (double eventPos[2])
virtual void	WidgetInteraction (double newEventPos[2])
virtual void	EndWidgetInteraction (double newEventPos[2])
virtual int	ComputeInteractionState (int X, int Y, int modify=0)
virtual int	GetInteractionState ()
virtual void	Highlight (int vtkNotUsed(highlightOn))
double *	GetBounds () override
	Methods to make this class behave as a vtkProp.
void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkProp.
void	GetActors (vtkPropCollection *) override
	For some exporters and other other operations we must be able to collect all the actors or volumes.
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.
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.
virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager.
virtual void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager.
virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking.
virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking.
void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking.
virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking.
virtual vtkRenderer *	GetRenderer ()
	Subclasses of vtkWidgetRepresentation must implement these methods.
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).
virtual double	GetPlaceFactor ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
virtual void	SetHandleSize (double)
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).
virtual double	GetHandleSize ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).
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).
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).
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).
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).
vtkWidgetRepresentation *	NewInstance () const
	Standard methods for instances of this class.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instances of this class.
Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkProp *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.
virtual void	GetActors2D (vtkPropCollection *)
virtual void	GetVolumes (vtkPropCollection *)
virtual void	Pick ()
	Method fires PickEvent if the prop is picked.
virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.
virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.
virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
virtual vtkMatrix4x4 *	GetMatrix ()
virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.
virtual int	RenderOpaqueGeometry (vtkViewport *)
	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.
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
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.
virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.
virtual vtkTypeBool	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.
virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.
virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
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.
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.
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.
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.
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.
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.
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.
virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers
virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.
virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.
virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.
virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.
virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.
virtual void	PickableOn ()
	Set/Get the pickable instance variable.
virtual void	PickableOff ()
	Set/Get the pickable instance variable.
virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.
virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.
virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.
virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.
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().
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().
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().
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().
virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.
virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.
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.
virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
virtual int	GetNumberOfConsumers ()
	Get the number of consumers.
void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.
int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.
virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.
virtual bool	IsRenderingTranslucentPolygonalGeometry ()
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkPointHandleRepresentation2D *	New ()
	Instantiate this class.
Static Public Member Functions inherited from vtkHandleRepresentation
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instances of this class.
static vtkHandleRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class.
Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instances of this class.
static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class.
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.
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.
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
	vtkPointHandleRepresentation2D ()
	~vtkPointHandleRepresentation2D () override
void	Translate (const double *eventPos) override
	Translates world position by vector v projected on the constraint axis if any.
void	Scale (const double eventPos[2])
void	CreateDefaultProperties ()
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.
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.
vtkAssemblyPath *	GetAssemblyPath3DPoint (double pos[3], vtkAbstractPropPicker *picker)
bool	NearbyEvent (int X, int Y, double bounds[6])
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
virtual vtkObjectBase *	NewInstanceInternal () const
	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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkActor2D *	Actor
vtkCoordinate *	MapperCoordinate
vtkPolyDataMapper2D *	Mapper
vtkGlyph2D *	Glypher
vtkPolyData *	CursorShape
vtkPolyData *	FocalData
vtkPoints *	FocalPoint
double	LastPickPosition [3]
double	LastEventPosition [2]
vtkProperty2D *	Property
vtkProperty2D *	SelectedProperty
int	WaitingForMotion
int	WaitCount
Protected Attributes inherited from vtkHandleRepresentation
int	Tolerance = 15
vtkTypeBool	ActiveRepresentation = false
vtkTypeBool	Constrained = false
vtkNew< vtkCoordinate >	DisplayPosition
vtkNew< vtkCoordinate >	WorldPosition
vtkTimeStamp	DisplayPositionTime
vtkTimeStamp	WorldPositionTime
vtkPointPlacer *	PointPlacer
int	TranslationAxis = Axis::NONE
double	CustomTranslationAxis [3] = { 1.0, 0.0, 0.0 }
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
vtkShaderProperty *	ShaderProperty
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkHandleRepresentation	Superclass
	Standard methods for instances of this class.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instances of this class.
static vtkPointHandleRepresentation2D *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class.
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instances of this class.
vtkPointHandleRepresentation2D *	NewInstance () const
	Standard methods for instances of this class.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instances of this class.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instances of this class.

Additional Inherited Members
Public Types inherited from vtkHandleRepresentation
enum	InteractionStateType {   Outside = 0 , Nearby , Selecting , Translating ,   Scaling }
typedef vtkWidgetRepresentation	Superclass
	Standard methods for instances of this class.
Public Types inherited from vtkWidgetRepresentation
enum	Axis {   NONE = -1 , XAxis = 0 , YAxis = 1 , ZAxis = 2 ,   Custom = 3 }
	Axis labels. More...
typedef vtkProp	Superclass
	Standard methods for instances of this class.
Public Types inherited from vtkProp
typedef vtkObject	Superclass
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

represent the position of a point in display coordinates

This class is used to represent a vtkHandleWidget. It represents a position in 2D world coordinates using a x-y cursor (the cursor defined by an instance of vtkPolyData and generated by a vtkPolyDataAlgorithm).

See also

vtkHandleRepresentation vtkHandleWidget

Examples:

vtkPointHandleRepresentation2D (Examples)

Online Examples:

SeedWidget

SeedWidgetImage

SeedWidgetWithCustomCallback

Tests:

vtkPointHandleRepresentation2D (Tests)

Definition at line 77 of file vtkPointHandleRepresentation2D.h.

Member Typedef Documentation

Superclass

typedef vtkHandleRepresentation vtkPointHandleRepresentation2D::Superclass

Standard methods for instances of this class.

Definition at line 89 of file vtkPointHandleRepresentation2D.h.

Constructor & Destructor Documentation

vtkPointHandleRepresentation2D()

vtkPointHandleRepresentation2D::vtkPointHandleRepresentation2D ( )

protected

~vtkPointHandleRepresentation2D()

vtkPointHandleRepresentation2D::~vtkPointHandleRepresentation2D ( )

overrideprotected

Member Function Documentation

New()

static vtkPointHandleRepresentation2D * vtkPointHandleRepresentation2D::New ( )

static

Instantiate this class.

IsTypeOf()

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

static

Standard methods for instances of this class.

IsA()

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

virtual

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

SafeDownCast()

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

static

Standard methods for instances of this class.

NewInstanceInternal()

virtual vtkObjectBase * vtkPointHandleRepresentation2D::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

NewInstance()

vtkPointHandleRepresentation2D * vtkPointHandleRepresentation2D::NewInstance

(

)

const

Standard methods for instances of this class.

PrintSelf()

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

overridevirtual

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

SetCursorShape()

void vtkPointHandleRepresentation2D::SetCursorShape

(

vtkPolyData *

cursorShape

)

Specify the cursor shape with an instance of vtkPolyData.

Note that shape is assumed to be defined in the display coordinate system. By default a vtkCursor2D shape is used.

GetCursorShape()

vtkPolyData * vtkPointHandleRepresentation2D::GetCursorShape

(

)

Specify the cursor shape with an instance of vtkPolyData.

Note that shape is assumed to be defined in the display coordinate system. By default a vtkCursor2D shape is used.

SetDisplayPosition()

void vtkPointHandleRepresentation2D::SetDisplayPosition ( double  xyz[3] )

override

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

This overloads the superclasses SetDisplayPosition in order to set the focal point of the cursor.

SetProperty()

void vtkPointHandleRepresentation2D::SetProperty

(

vtkProperty2D *

)

Set/Get the handle properties when unselected and selected.

SetSelectedProperty()

void vtkPointHandleRepresentation2D::SetSelectedProperty

(

vtkProperty2D *

)

Set/Get the handle properties when unselected and selected.

GetProperty()

virtual vtkProperty2D * vtkPointHandleRepresentation2D::GetProperty ( )

virtual

Set/Get the handle properties when unselected and selected.

GetSelectedProperty()

virtual vtkProperty2D * vtkPointHandleRepresentation2D::GetSelectedProperty ( )

virtual

Set/Get the handle properties when unselected and selected.

GetBounds()

double * vtkPointHandleRepresentation2D::GetBounds ( )

overridevirtual

Subclasses of vtkPointHandleRepresentation2D must implement these methods.

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

Reimplemented from vtkProp.

BuildRepresentation()

void vtkPointHandleRepresentation2D::BuildRepresentation ( )

overridevirtual

Subclasses of vtkPointHandleRepresentation2D must implement these methods.

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

Implements vtkWidgetRepresentation.

StartWidgetInteraction()

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

overridevirtual

Subclasses of vtkPointHandleRepresentation2D must implement these methods.

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

Reimplemented from vtkWidgetRepresentation.

WidgetInteraction()

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

overridevirtual

Subclasses of vtkPointHandleRepresentation2D must implement these methods.

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

Reimplemented from vtkWidgetRepresentation.

ComputeInteractionState()

int vtkPointHandleRepresentation2D::ComputeInteractionState ( int  X, int  Y, int  modify = 0  )

overridevirtual

Subclasses of vtkPointHandleRepresentation2D must implement these methods.

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

Reimplemented from vtkWidgetRepresentation.

ShallowCopy()

void vtkPointHandleRepresentation2D::ShallowCopy ( vtkProp *  prop )

overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkHandleRepresentation.

DeepCopy()

void vtkPointHandleRepresentation2D::DeepCopy ( vtkProp *  prop )

overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkHandleRepresentation.

GetActors2D()

void vtkPointHandleRepresentation2D::GetActors2D ( vtkPropCollection *  )

overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

ReleaseGraphicsResources()

void vtkPointHandleRepresentation2D::ReleaseGraphicsResources ( vtkWindow *  )

overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

RenderOverlay()

int vtkPointHandleRepresentation2D::RenderOverlay ( vtkViewport *  viewport )

overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

Highlight()

void vtkPointHandleRepresentation2D::Highlight ( int  highlight )

override

SetPointPlacer()

void vtkPointHandleRepresentation2D::SetPointPlacer ( vtkPointPlacer *  )

overridevirtual

Override the superclass implementation.

This class does not use a point placer. Point placers dictate the placement of points in 3D space. Since this class constrains points to lie in an overlay plane anyway, we don't care. Just returns.

Reimplemented from vtkHandleRepresentation.

SetVisibility()

void vtkPointHandleRepresentation2D::SetVisibility ( vtkTypeBool  visible )

overridevirtual

Override to ensure that the internal actor's visibility is consistent with this representation's visibility.

Inconsistency between the two would cause issues in picking logic which relies on individual view prop visibility to determine whether the prop is pickable.

Reimplemented from vtkProp.

Translate() [1/3]

void vtkPointHandleRepresentation2D::Translate ( const double *  v )

overrideprotectedvirtual

Translates world position by vector v projected on the constraint axis if any.

Reimplemented from vtkHandleRepresentation.

Scale()

void vtkPointHandleRepresentation2D::Scale ( const double  eventPos[2] )

protected

CreateDefaultProperties()

void vtkPointHandleRepresentation2D::CreateDefaultProperties ( )

protected

Translate() [2/3]

virtual void vtkHandleRepresentation::Translate ( const double *  p1, const double *  p2  )

virtual

Translates world position by vector p1p2 projected on the constraint axis if any.

Reimplemented from vtkHandleRepresentation.

Translate() [3/3]

virtual void vtkHandleRepresentation::Translate ( const double *  v )

virtual

Translates world position by vector v projected on the constraint axis if any.

Reimplemented from vtkHandleRepresentation.

Member Data Documentation

Actor

vtkActor2D* vtkPointHandleRepresentation2D::Actor

protected

Definition at line 169 of file vtkPointHandleRepresentation2D.h.

MapperCoordinate

vtkCoordinate* vtkPointHandleRepresentation2D::MapperCoordinate

protected

Definition at line 170 of file vtkPointHandleRepresentation2D.h.

Mapper

vtkPolyDataMapper2D* vtkPointHandleRepresentation2D::Mapper

protected

Definition at line 171 of file vtkPointHandleRepresentation2D.h.

Glypher

vtkGlyph2D* vtkPointHandleRepresentation2D::Glypher

protected

Definition at line 172 of file vtkPointHandleRepresentation2D.h.

CursorShape

vtkPolyData* vtkPointHandleRepresentation2D::CursorShape

protected

Definition at line 173 of file vtkPointHandleRepresentation2D.h.

FocalData

vtkPolyData* vtkPointHandleRepresentation2D::FocalData

protected

Definition at line 174 of file vtkPointHandleRepresentation2D.h.

FocalPoint

vtkPoints* vtkPointHandleRepresentation2D::FocalPoint

protected

Definition at line 175 of file vtkPointHandleRepresentation2D.h.

LastPickPosition

double vtkPointHandleRepresentation2D::LastPickPosition[3]

protected

Definition at line 178 of file vtkPointHandleRepresentation2D.h.

LastEventPosition

double vtkPointHandleRepresentation2D::LastEventPosition[2]

protected

Definition at line 179 of file vtkPointHandleRepresentation2D.h.

Property

vtkProperty2D* vtkPointHandleRepresentation2D::Property

protected

Definition at line 187 of file vtkPointHandleRepresentation2D.h.

SelectedProperty

vtkProperty2D* vtkPointHandleRepresentation2D::SelectedProperty

protected

Definition at line 188 of file vtkPointHandleRepresentation2D.h.

WaitingForMotion

int vtkPointHandleRepresentation2D::WaitingForMotion

protected

Definition at line 192 of file vtkPointHandleRepresentation2D.h.

WaitCount

int vtkPointHandleRepresentation2D::WaitCount

protected

Definition at line 193 of file vtkPointHandleRepresentation2D.h.

---

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

• Interaction/Widgets/vtkPointHandleRepresentation2D.h