a class defining the representation for a vtkCoordinateFrameWidget More...

#include <vtkCoordinateFrameRepresentation.h>

Inheritance diagram for vtkCoordinateFrameRepresentation:

Collaboration diagram for vtkCoordinateFrameRepresentation:

Public Types
enum	InteractionStateType { Outside = 0 , Moving , MovingOrigin , RotatingXVector , RotatingYVector , RotatingZVector , ModifyingLockerXVector , ModifyingLockerYVector , ModifyingLockerZVector }

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

Public Member Functions
void	UpdatePlacement ()
	Satisfies the superclass API.

void	Reset ()
	Reset the origin (by calling update placement) and the axes (to be aligned with the world coordinate X, Y, and Z axes).

void	ResetAxes ()
	Reset only the axis orientations (not the origin).

bool	PickOrigin (int X, int Y, bool snapToMeshPoint=false)
	Given the X, Y display coordinates, pick a new origin for the coordinate frame from a point that is on the objects rendered by the renderer.

bool	PickNormal (int X, int Y, bool snapToMeshPoint=false)
	Given the X, Y display coordinates, pick a new normal for the coordinate frame from a point that is on the objects rendered by the renderer.

bool	PickDirectionPoint (int X, int Y, bool snapToMeshPoint=false)
	Given the X, Y display coordinates, pick a point and using the origin define normal for the coordinate frame from a point that is on the objects rendered by the renderer.

int	GetLockedAxis () const
	Get/set which axis (if any) is locked.

void	SetLockedAxis (int axis)


void	SetOrigin (double x, double y, double z)
	Set/Get the origin of the coordinate frame.

void	SetOrigin (double x[3])
	Set/Get the origin of the coordinate frame.

virtual double *	GetOrigin ()
	Set/Get the origin of the coordinate frame.

virtual void	GetOrigin (double &, double &, double &)
	Set/Get the origin of the coordinate frame.

virtual void	GetOrigin (double[3])
	Set/Get the origin of the coordinate frame.


void	SetNormal (double x, double y, double z)
	Set/Get the normal of one of the axes of the coordinate frame.

void	SetNormal (double n[3])
	Set/Get the normal of one of the axes of the coordinate frame.

void	SetNormalToCamera ()
	Set/Get the normal of one of the axes of the coordinate frame.

virtual double *	GetXVectorNormal ()
	Set/Get the normal of one of the axes of the coordinate frame.

virtual void	GetXVectorNormal (double &, double &, double &)
	Set/Get the normal of one of the axes of the coordinate frame.

virtual void	GetXVectorNormal (double[3])
	Set/Get the normal of one of the axes of the coordinate frame.

virtual double *	GetYVectorNormal ()
	Set/Get the normal of one of the axes of the coordinate frame.

virtual void	GetYVectorNormal (double &, double &, double &)
	Set/Get the normal of one of the axes of the coordinate frame.

virtual void	GetYVectorNormal (double[3])
	Set/Get the normal of one of the axes of the coordinate frame.

virtual double *	GetZVectorNormal ()
	Set/Get the normal of one of the axes of the coordinate frame.

virtual void	GetZVectorNormal (double &, double &, double &)
	Set/Get the normal of one of the axes of the coordinate frame.

virtual void	GetZVectorNormal (double[3])
	Set/Get the normal of one of the axes of the coordinate frame.


void	SetDirection (double x, double y, double z)
	Set the direction of the locked (or absent a locked axis, the nearest axis) to point from the frame's origin toward the given (x,y,z) location.

void	SetDirection (double d[3])
	Set the direction of the locked (or absent a locked axis, the nearest axis) to point from the frame's origin toward the given (x,y,z) location.


void	SetXAxisVector (const double v[3])
	Force an axis to be aligned with the vector v, regardless of whether any axis is locked.

void	SetXAxisVector (double x, double y, double z)
	Force an axis to be aligned with the vector v, regardless of whether any axis is locked.

void	SetYAxisVector (const double v[3])
	Force an axis to be aligned with the vector v, regardless of whether any axis is locked.

void	SetYAxisVector (double x, double y, double z)
	Force an axis to be aligned with the vector v, regardless of whether any axis is locked.

void	SetZAxisVector (const double v[3])
	Force an axis to be aligned with the vector v, regardless of whether any axis is locked.

void	SetZAxisVector (double x, double y, double z)
	Force an axis to be aligned with the vector v, regardless of whether any axis is locked.


virtual void	SetLockNormalToCamera (vtkTypeBool)
	If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal.

virtual vtkTypeBool	GetLockNormalToCamera ()
	If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal.

virtual void	LockNormalToCameraOn ()
	If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal.

virtual void	LockNormalToCameraOff ()
	If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal.


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	SetTranslationAxisOff ()
	Toggles constraint translation axis on/off.


bool	IsTranslationConstrained ()
	Returns true if ConstrainedAxis.


virtual vtkProperty *	GetOriginProperty ()
	Get the properties of the origin.

virtual vtkProperty *	GetSelectedOriginProperty ()
	Get the properties of the origin.


virtual vtkProperty *	GetXVectorProperty ()
	Get the properties on the XVector.

virtual vtkProperty *	GetSelectedXVectorProperty ()
	Get the properties on the XVector.


virtual vtkProperty *	GetLockedXVectorProperty ()
	Get the properties on the LockedXVector.

virtual vtkProperty *	GetSelectedLockedXVectorProperty ()
	Get the properties on the LockedXVector.


virtual vtkProperty *	GetUnlockedXVectorProperty ()
	Get the properties on the UnlockedXVector.

virtual vtkProperty *	GetSelectedUnlockedXVectorProperty ()
	Get the properties on the UnlockedXVector.


virtual vtkProperty *	GetYVectorProperty ()
	Get the properties on the YVector.

virtual vtkProperty *	GetSelectedYVectorProperty ()
	Get the properties on the YVector.


virtual vtkProperty *	GetLockedYVectorProperty ()
	Get the properties on the LockedYVector.

virtual vtkProperty *	GetSelectedLockedYVectorProperty ()
	Get the properties on the LockedYVector.


virtual vtkProperty *	GetUnlockedYVectorProperty ()
	Get the properties on the UnlockedYVector.

virtual vtkProperty *	GetSelectedUnlockedYVectorProperty ()
	Get the properties on the UnlockedYVector.


virtual vtkProperty *	GetZVectorProperty ()
	Get the properties on the ZVector.

virtual vtkProperty *	GetSelectedZVectorProperty ()
	Get the properties on the ZVector.


virtual vtkProperty *	GetLockedZVectorProperty ()
	Get the properties on the LockedZVector.

virtual vtkProperty *	GetSelectedLockedZVectorProperty ()
	Get the properties on the LockedZVector.


virtual vtkProperty *	GetUnlockedZVectorProperty ()
	Get the properties on the UnlockedZVector.

virtual vtkProperty *	GetSelectedUnlockedZVectorProperty ()
	Get the properties on the UnlockedZVector.


virtual bool	GetPickCameraFocalInfo ()
	Enable/Disable picking camera focal info if no result is available for PickOrigin, PickNormal and PickDirectionPoint.

virtual void	SetPickCameraFocalInfo (bool)
	Enable/Disable picking camera focal info if no result is available for PickOrigin, PickNormal and PickDirectionPoint.

virtual void	PickCameraFocalInfoOn ()
	Enable/Disable picking camera focal info if no result is available for PickOrigin, PickNormal and PickDirectionPoint.

virtual void	PickCameraFocalInfoOff ()
	Enable/Disable picking camera focal info if no result is available for PickOrigin, PickNormal and PickDirectionPoint.


int	ComputeInteractionState (int X, int Y, int modify=0) override
	Methods to interface with the vtkCoordinateFrameWidget.

void	PlaceWidget (double bounds[6]) override
	Methods to interface with the vtkCoordinateFrameWidget.

void	BuildRepresentation () override
	Methods to interface with the vtkCoordinateFrameWidget.

void	StartWidgetInteraction (double eventPos[2]) override
	Methods to interface with the vtkCoordinateFrameWidget.

void	WidgetInteraction (double newEventPos[2]) override
	Methods to interface with the vtkCoordinateFrameWidget.

void	EndWidgetInteraction (double newEventPos[2]) override
	Methods to interface with the vtkCoordinateFrameWidget.


double *	GetBounds () override
	Methods supporting the rendering process.

void	GetActors (vtkPropCollection *pc) override
	Methods supporting the rendering process.

void	ReleaseGraphicsResources (vtkWindow *) override
	Methods supporting the rendering process.

int	RenderOpaqueGeometry (vtkViewport *) override
	Methods supporting the rendering process.

int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	Methods supporting the rendering process.

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Methods supporting the rendering process.


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


virtual void	SetRepresentationState (int)
	Sets the visual appearance of the representation based on the state it is in.

virtual int	GetRepresentationState ()
	Sets the visual appearance of the representation based on the state it is in.


virtual void	SetLengthFactor (double)
	Set/get the length of the axis glyphs relative to screen size.

virtual double	GetLengthFactor ()
	Set/get the length of the axis glyphs relative to screen size.

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 void	SetRenderer (vtkRenderer *ren)
	Subclasses of vtkWidgetRepresentation must implement these methods.

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

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 vtkCoordinateFrameRepresentation *	New ()
	Instantiate the 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
	vtkCoordinateFrameRepresentation ()

	~vtkCoordinateFrameRepresentation () override

virtual void	SetXVectorNormal (double, double, double)

virtual void	SetXVectorNormal (double[3])

virtual void	SetYVectorNormal (double, double, double)

virtual void	SetYVectorNormal (double[3])

virtual void	SetZVectorNormal (double, double, double)

virtual void	SetZVectorNormal (double[3])

void	HighlightOrigin (int highlight)

void	HighlightXVector (int highlight)

void	HighlightLockerXVector (int highlight)

void	HighlightYVector (int highlight)

void	HighlightLockerYVector (int highlight)

void	HighlightZVector (int highlight)

void	HighlightLockerZVector (int highlight)

void	ComputeAdaptivePickerTolerance ()

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

void	Rotate (double X, double Y, double p1, double p2, double *vpn)

void	ModifyingLocker (int axis)

void	TranslateOrigin (double p1, double p2)

void	SizeHandles ()

virtual void	CreateDefaultProperties ()

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation () override

vtkVector3d	GetWorldPoint (vtkAbstractPicker *picker, double screenPos[2])
	Return the given screen point in world coordinates, based on picked position.

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
int	RepresentationState = Outside

double	LastEventPosition [3]

bool	PickCameraFocalInfo = false

vtkTypeBool	LockNormalToCamera = false

int	TranslationAxis = Axis::NONE

double	Origin [3] = { 0, 0, 0 }

double	XVectorNormal [3] = { 1, 0, 0 }

double	YVectorNormal [3] = { 0, 1, 0 }

double	ZVectorNormal [3] = { 0, 0, 1 }

vtkNew< vtkSphereSource >	OriginSphereSource

vtkNew< vtkPolyDataMapper >	OriginSphereMapper

vtkNew< vtkActor >	OriginSphereActor

vtkNew< vtkLineSource >	XVectorLineSource

vtkNew< vtkPolyDataMapper >	XVectorLineMapper

vtkNew< vtkActor >	XVectorLineActor

vtkNew< vtkConeSource >	XVectorConeSource

vtkNew< vtkPolyDataMapper >	XVectorConeMapper

vtkNew< vtkActor >	XVectorConeActor

bool	XVectorIsLocked = false

vtkNew< vtkConeSource >	LockerXVectorConeSource

vtkNew< vtkPolyDataMapper >	LockerXVectorConeMapper

vtkNew< vtkActor >	LockerXVectorConeActor

vtkNew< vtkLineSource >	YVectorLineSource

vtkNew< vtkPolyDataMapper >	YVectorLineMapper

vtkNew< vtkActor >	YVectorLineActor

vtkNew< vtkConeSource >	YVectorConeSource

vtkNew< vtkPolyDataMapper >	YVectorConeMapper

vtkNew< vtkActor >	YVectorConeActor

bool	YVectorIsLocked = false

vtkNew< vtkConeSource >	LockerYVectorConeSource

vtkNew< vtkPolyDataMapper >	LockerYVectorConeMapper

vtkNew< vtkActor >	LockerYVectorConeActor

vtkNew< vtkLineSource >	ZVectorLineSource

vtkNew< vtkPolyDataMapper >	ZVectorLineMapper

vtkNew< vtkActor >	ZVectorLineActor

vtkNew< vtkConeSource >	ZVectorConeSource

vtkNew< vtkPolyDataMapper >	ZVectorConeMapper

vtkNew< vtkActor >	ZVectorConeActor

bool	ZVectorIsLocked = false

vtkNew< vtkConeSource >	LockerZVectorConeSource

vtkNew< vtkPolyDataMapper >	LockerZVectorConeMapper

vtkNew< vtkActor >	LockerZVectorConeActor

vtkNew< vtkHardwarePicker >	HardwarePicker

vtkNew< vtkCellPicker >	CellPicker

vtkNew< vtkTransform >	Transform

vtkNew< vtkProperty >	OriginProperty

vtkNew< vtkProperty >	SelectedOriginProperty

vtkNew< vtkProperty >	XVectorProperty

vtkNew< vtkProperty >	SelectedXVectorProperty

vtkNew< vtkProperty >	LockedXVectorProperty

vtkNew< vtkProperty >	SelectedLockedXVectorProperty

vtkNew< vtkProperty >	UnlockedXVectorProperty

vtkNew< vtkProperty >	SelectedUnlockedXVectorProperty

vtkNew< vtkProperty >	YVectorProperty

vtkNew< vtkProperty >	SelectedYVectorProperty

vtkNew< vtkProperty >	LockedYVectorProperty

vtkNew< vtkProperty >	SelectedLockedYVectorProperty

vtkNew< vtkProperty >	UnlockedYVectorProperty

vtkNew< vtkProperty >	SelectedUnlockedYVectorProperty

vtkNew< vtkProperty >	ZVectorProperty

vtkNew< vtkProperty >	SelectedZVectorProperty

vtkNew< vtkProperty >	LockedZVectorProperty

vtkNew< vtkProperty >	SelectedLockedZVectorProperty

vtkNew< vtkProperty >	UnlockedZVectorProperty

vtkNew< vtkProperty >	SelectedUnlockedZVectorProperty

vtkNew< vtkBox >	BoundingBox

vtkNew< vtkGenericCell >	Cell

double	LengthFactor = 0.04

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 vtkWidgetRepresentation	Superclass
	Standard methods for the class.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for the class.

static vtkCoordinateFrameRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for the class.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for the class.

vtkCoordinateFrameRepresentation *	NewInstance () const
	Standard methods for the class.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for the class.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for the class.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

a class defining the representation for a vtkCoordinateFrameWidget

This class is a concrete representation for the vtkCoordinateFrameWidget. It represents a coordinate frame with an origin, 3 axis and 3 axis lockers. Through interaction with the widget, the coordinate frame can be manipulated by adjusting the axis normals, locking them, or moving/picking the origin point.

The PlaceWidget() method is also used to initially position the representation.

Warning: This class, and vtkCoordinateFrameWidget, are next generation VTK widgets.

Tests:: vtkCoordinateFrameRepresentation (Tests)

Definition at line 47 of file vtkCoordinateFrameRepresentation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkWidgetRepresentation vtkCoordinateFrameRepresentation::Superclass

Standard methods for the class.

Definition at line 60 of file vtkCoordinateFrameRepresentation.h.

Member Enumeration Documentation

◆ InteractionStateType

enum vtkCoordinateFrameRepresentation::InteractionStateType

Enumerator
Outside
Moving
MovingOrigin
RotatingXVector
RotatingYVector
RotatingZVector
ModifyingLockerXVector
ModifyingLockerYVector
ModifyingLockerZVector

Definition at line 334 of file vtkCoordinateFrameRepresentation.h.

Constructor & Destructor Documentation

◆ vtkCoordinateFrameRepresentation()

vtkCoordinateFrameRepresentation::vtkCoordinateFrameRepresentation ( )

protected

◆ ~vtkCoordinateFrameRepresentation()

vtkCoordinateFrameRepresentation::~vtkCoordinateFrameRepresentation ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkCoordinateFrameRepresentation * vtkCoordinateFrameRepresentation::New ( )

static

Instantiate the class.

◆ IsTypeOf()

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

static

Standard methods for the class.

◆ IsA()

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

virtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

◆ SafeDownCast()

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

static

Standard methods for the class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCoordinateFrameRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

◆ NewInstance()

vtkCoordinateFrameRepresentation * vtkCoordinateFrameRepresentation::NewInstance ( ) const

Standard methods for the class.

◆ PrintSelf()

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

overridevirtual

Standard methods for the class.

Reimplemented from vtkObjectBase.

◆ SetOrigin() [1/2]

void vtkCoordinateFrameRepresentation::SetOrigin	(	double	x,
		double	y,
		double	z
	)

Set/Get the origin of the coordinate frame.

◆ SetOrigin() [2/2]

void vtkCoordinateFrameRepresentation::SetOrigin ( double x[3] )

Set/Get the origin of the coordinate frame.

◆ GetOrigin() [1/3]

virtual double * vtkCoordinateFrameRepresentation::GetOrigin ( )

virtual

Set/Get the origin of the coordinate frame.

◆ GetOrigin() [2/3]

virtual void vtkCoordinateFrameRepresentation::GetOrigin	(	double &	,
		double &	,
		double &
	)

virtual

Set/Get the origin of the coordinate frame.

◆ GetOrigin() [3/3]

virtual void vtkCoordinateFrameRepresentation::GetOrigin ( double [3] )

virtual

Set/Get the origin of the coordinate frame.