class defining a representation for the vtkTensorWidget More...

#include <vtkTensorRepresentation.h>

Inheritance diagram for vtkTensorRepresentation:

Collaboration diagram for vtkTensorRepresentation:

Public Types
enum	{ Outside = 0 , MoveF0 , MoveF1 , MoveF2 , MoveF3 , MoveF4 , MoveF5 , Translating , Rotating , Scaling }

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	GetPolyData (vtkPolyData *pd)
	Grab the polydata (including points) that define the representation.

void	PlaceTensor (double tensor[9], double position[3])
	This is a specialized place widget method for a tensor.

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

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


void	SetTensor (double tensor[9])
	These are the basic methods used to define the tensor (these methods coordinate with the overloaded PlaceWidget() method).

void	SetSymmetricTensor (double symTensor[6])
	These are the basic methods used to define the tensor (these methods coordinate with the overloaded PlaceWidget() method).

void	GetTensor (double tensor[9])
	These are the basic methods used to define the tensor (these methods coordinate with the overloaded PlaceWidget() method).

void	GetSymmetricTensor (double symTensor[6])
	These are the basic methods used to define the tensor (these methods coordinate with the overloaded PlaceWidget() method).


void	GetEigenvalues (double evals[3])
	These are methods used to retrieve derived information about the tensor.

void	GetEigenvector (int n, double ev[3])
	These are methods used to retrieve derived information about the tensor.


void	SetPosition (double pos[3])
	Set/Get a position for the location of the tensor.

void	GetPosition (double pos[3])
	Set/Get a position for the location of the tensor.


virtual vtkProperty *	GetHandleProperty ()
	Get the handle properties (the little balls are the handles).

virtual vtkProperty *	GetSelectedHandleProperty ()
	Get the handle properties (the little balls are the handles).


virtual vtkProperty *	GetFaceProperty ()
	Get the face properties (the faces of the box).

virtual vtkProperty *	GetSelectedFaceProperty ()
	Get the face properties (the faces of the box).


virtual vtkProperty *	GetOutlineProperty ()
	Get the outline properties (the outline of the box).

virtual vtkProperty *	GetSelectedOutlineProperty ()
	Get the outline properties (the outline of the box).


virtual vtkProperty *	GetEllipsoidProperty ()
	Get the tensor ellipsoid properties.


void	SetOutlineFaceWires (bool)
	Control the representation of the outline.

virtual bool	GetOutlineFaceWires ()
	Control the representation of the outline.

void	OutlineFaceWiresOn ()
	Control the representation of the outline.

void	OutlineFaceWiresOff ()
	Control the representation of the outline.


void	SetOutlineCursorWires (bool)
	Control the representation of the outline.

virtual bool	GetOutlineCursorWires ()
	Control the representation of the outline.

void	OutlineCursorWiresOn ()
	Control the representation of the outline.

void	OutlineCursorWiresOff ()
	Control the representation of the outline.


virtual void	HandlesOn ()
	Switches handles (the spheres) on or off by manipulating the underlying actor visibility.

virtual void	HandlesOff ()
	Switches handles (the spheres) on or off by manipulating the underlying actor visibility.


void	SetTensorEllipsoid (bool)
	Indicate whether to show the tensor ellipsoid.

virtual bool	GetTensorEllipsoid ()
	Indicate whether to show the tensor ellipsoid.

void	TensorEllipsoidOn ()
	Indicate whether to show the tensor ellipsoid.

void	TensorEllipsoidOff ()
	Indicate whether to show the tensor ellipsoid.


void	PlaceWidget (double bounds[6]) override
	These are methods that satisfy vtkWidgetRepresentation's API.

void	BuildRepresentation () override
	These are methods that satisfy vtkWidgetRepresentation's API.

int	ComputeInteractionState (int X, int Y, int modify=0) override
	These are methods that satisfy vtkWidgetRepresentation's API.

void	StartWidgetInteraction (double e[2]) override
	These are methods that satisfy vtkWidgetRepresentation's API.

void	WidgetInteraction (double e[2]) override
	These are methods that satisfy vtkWidgetRepresentation's API.

double *	GetBounds () override
	These are methods that satisfy vtkWidgetRepresentation's API.

void	StartComplexInteraction (vtkRenderWindowInteractor iren, vtkAbstractWidget widget, unsigned long event, void *calldata) override
	These are methods that satisfy vtkWidgetRepresentation's API.

void	ComplexInteraction (vtkRenderWindowInteractor iren, vtkAbstractWidget widget, unsigned long event, void *calldata) override
	These are methods that satisfy vtkWidgetRepresentation's API.

int	ComputeComplexInteractionState (vtkRenderWindowInteractor iren, vtkAbstractWidget widget, unsigned long event, void *calldata, int modify=0) override
	These are methods that satisfy vtkWidgetRepresentation's API.

void	EndComplexInteraction (vtkRenderWindowInteractor iren, vtkAbstractWidget widget, unsigned long event, void *calldata) override
	These are methods that satisfy vtkWidgetRepresentation's API.


void	ReleaseGraphicsResources (vtkWindow *) override
	Methods supporting, and required by, the rendering process.

int	RenderOpaqueGeometry (vtkViewport *) override
	Methods supporting, and required by, the rendering process.

int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	Methods supporting, and required by, the rendering process.

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Methods supporting, and required by, the rendering process.


virtual bool	GetSnapToAxes ()
	For complex events should we snap orientations to be aligned with the x y z axes.

virtual void	SetSnapToAxes (bool)
	For complex events should we snap orientations to be aligned with the x y z axes.


void	StepForward ()
	For complex events should we snap orientations to be aligned with the x y z axes.

void	StepBackward ()
	For complex events should we snap orientations to be aligned with the x y z axes.


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


bool	IsTranslationConstrained ()
	Returns true if ConstrainedAxis.

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

Protected Member Functions
	vtkTensorRepresentation ()

	~vtkTensorRepresentation () override

virtual void	PositionHandles ()

int	HighlightHandle (vtkProp *prop)

void	HighlightFace (int cellId)

void	HighlightOutline (int highlight)

virtual void	ComputeNormals ()

virtual void	SizeHandles ()

virtual void	CreateDefaultProperties ()

void	GenerateOutline ()

void	UpdateTensorFromWidget ()

void	UpdateWidgetFromTensor ()

void	UpdateTensorEigenfunctions (double tensor[3][3])

virtual void	Translate (const double p1, const double p2)

virtual void	Scale (const double p1, const double p2, int X, int Y)

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

void	MovePlusXFace (const double p1, const double p2, bool entry)

void	MoveMinusXFace (const double p1, const double p2, bool entry)

void	MovePlusYFace (const double p1, const double p2, bool entry)

void	MoveMinusYFace (const double p1, const double p2, bool entry)

void	MovePlusZFace (const double p1, const double p2, bool entry)

void	MoveMinusZFace (const double p1, const double p2, bool entry)

void	UpdatePose (const double p1, const double d1, const double p2, const double d2)

void	MoveFace (const double p1, const double p2, const double dir, double x1, double x2, double x3, double x4, double x5)

void	GetDirection (const double Nx[3], const double Ny[3], const double Nz[3], double dir[3])

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
double	Tensor [9]

double	Eigenvalues [3]

double	Eigenvectors [3][3]

double	TensorPosition [3]

double	LastEventPosition [3]

double	LastEventOrientation [4]

double	StartEventOrientation [4]

double	SnappedEventOrientations [3][4]

bool	SnappedOrientation [3]

bool	SnapToAxes

int	TranslationAxis

vtkActor *	HexActor

vtkPolyDataMapper *	HexMapper

vtkPolyData *	HexPolyData

vtkPoints *	Points

double	N [6][3]

vtkActor *	HexFace

vtkPolyDataMapper *	HexFaceMapper

vtkPolyData *	HexFacePolyData

vtkActor **	Handle

vtkPolyDataMapper **	HandleMapper

vtkSphereSource **	HandleGeometry

vtkActor *	HexOutline

vtkPolyDataMapper *	OutlineMapper

vtkPolyData *	OutlinePolyData

vtkActor *	EllipsoidActor

vtkTransform *	EllipsoidTransform

vtkMatrix4x4 *	EllipsoidMatrix

vtkPolyDataMapper *	EllipsoidMapper

vtkSphereSource *	EllipsoidSource

vtkCellPicker *	HandlePicker

vtkCellPicker *	HexPicker

vtkActor *	CurrentHandle

int	CurrentHexFace

vtkCellPicker *	LastPicker

vtkTransform *	Transform

vtkMatrix4x4 *	Matrix

vtkPoints *	TmpPoints

vtkBox *	BoundingBox

vtkProperty *	HandleProperty

vtkProperty *	SelectedHandleProperty

vtkProperty *	FaceProperty

vtkProperty *	SelectedFaceProperty

vtkProperty *	OutlineProperty

vtkProperty *	SelectedOutlineProperty

vtkProperty *	EllipsoidProperty

bool	InsideOut

bool	OutlineFaceWires

bool	OutlineCursorWires

bool	TensorEllipsoid

vtkPoints *	PlanePoints

vtkDoubleArray *	PlaneNormals

vtkPlane *	Planes [6]

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 instantiation, obtaining type information, and printing.

static vtkTensorRepresentation *	New ()
	Standard methods for instantiation, obtaining type information, and printing.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instantiation, obtaining type information, and printing.

static vtkTensorRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiation, obtaining type information, and printing.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiation, obtaining type information, and printing.

vtkTensorRepresentation *	NewInstance () const
	Standard methods for instantiation, obtaining type information, and printing.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiation, obtaining type information, and printing.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiation, obtaining type information, and printing.

Additional Inherited Members
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.

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

class defining a representation for the vtkTensorWidget

This class is a concrete representation for the vtkTensorWidget. In summary, it allows the editing of a tensor glyph (by modifying the underlying tensor value). This includes controlling the position, scaling, and rotation of the glyph. The representation is simply an oriented, scaled box which can be manipulated to transform the tensor. Optionally, an ellipsoid defined by the tensor eigenvectors can be shown for informational purposes.

To use this representation, specify a 3x3 real, symmetric matrix defining the tensor. (This implicitly defines an orthogonal basis from the three tensor eigenvectors.) Then use PlaceWidget() to define a bounding box: the bounding box defines a position for the tensor from its center point, and the representation is scaled to fit in the bounding box.

Note: typical usage is to place a tensor glyph inside of the representation (i.e., the box) which is updated as the representation is manipulated by the user. The built-in ellipsoid can be used for this; alternatively through callbacks and such, it is possible to place other glyph types such as superquadrics.

See also: vtkTensorWidget vtkBoxRepresentation

Tests:: vtkTensorRepresentation (Tests)

Definition at line 59 of file vtkTensorRepresentation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkWidgetRepresentation vtkTensorRepresentation::Superclass

Standard methods for instantiation, obtaining type information, and printing.

Definition at line 68 of file vtkTensorRepresentation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
Outside
MoveF0
MoveF1
MoveF2
MoveF3
MoveF4
MoveF5
Translating
Rotating
Scaling

Definition at line 262 of file vtkTensorRepresentation.h.

Constructor & Destructor Documentation

◆ vtkTensorRepresentation()

vtkTensorRepresentation::vtkTensorRepresentation ( )

protected

◆ ~vtkTensorRepresentation()

vtkTensorRepresentation::~vtkTensorRepresentation ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkTensorRepresentation * vtkTensorRepresentation::New ( )

static

Standard methods for instantiation, obtaining type information, and printing.

◆ IsTypeOf()

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

static

Standard methods for instantiation, obtaining type information, and printing.

◆ IsA()

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

virtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkWidgetRepresentation.

◆ SafeDownCast()

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

static

Standard methods for instantiation, obtaining type information, and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkTensorRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkWidgetRepresentation.

◆ NewInstance()

vtkTensorRepresentation * vtkTensorRepresentation::NewInstance ( ) const

Standard methods for instantiation, obtaining type information, and printing.

◆ PrintSelf()

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

overridevirtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkProp.

◆ SetTensor()

void vtkTensorRepresentation::SetTensor ( double tensor[9] )

These are the basic methods used to define the tensor (these methods coordinate with the overloaded PlaceWidget() method).

The methods enable specification of a 3x3 symmetric tensor. This information is used to construct an oriented, appropriately ellipsoid that is (initially) centered and fits inside the bounding box defined by PlaceWidget(). As this widget is modified during user interaction, the tensor data member is continuously updated and can be queried. Note that a symmetric tensor can be defined with only six components. If a full 3x3 tensor is specified, only the symmetrical part of the tensor is used since the extracted eigenvalues/eigenvecters are required to be real valued. When a tensor is specified, the derived information (e.g., eigenvalues/vectors and position) are immediately updated.

◆ SetSymmetricTensor()

void vtkTensorRepresentation::SetSymmetricTensor ( double symTensor[6] )

These are the basic methods used to define the tensor (these methods coordinate with the overloaded PlaceWidget() method).

The methods enable specification of a 3x3 symmetric tensor. This information is used to construct an oriented, appropriately ellipsoid that is (initially) centered and fits inside the bounding box defined by PlaceWidget(). As this widget is modified during user interaction, the tensor data member is continuously updated and can be queried. Note that a symmetric tensor can be defined with only six components. If a full 3x3 tensor is specified, only the symmetrical part of the tensor is used since the extracted eigenvalues/eigenvecters are required to be real valued. When a tensor is specified, the derived information (e.g., eigenvalues/vectors and position) are immediately updated.

◆ GetTensor()

void vtkTensorRepresentation::GetTensor ( double tensor[9] )

inline

These are the basic methods used to define the tensor (these methods coordinate with the overloaded PlaceWidget() method).

The methods enable specification of a 3x3 symmetric tensor. This information is used to construct an oriented, appropriately ellipsoid that is (initially) centered and fits inside the bounding box defined by PlaceWidget(). As this widget is modified during user interaction, the tensor data member is continuously updated and can be queried. Note that a symmetric tensor can be defined with only six components. If a full 3x3 tensor is specified, only the symmetrical part of the tensor is used since the extracted eigenvalues/eigenvecters are required to be real valued. When a tensor is specified, the derived information (e.g., eigenvalues/vectors and position) are immediately updated.

Definition at line 89 of file vtkTensorRepresentation.h.

◆ GetSymmetricTensor()

void vtkTensorRepresentation::GetSymmetricTensor ( double symTensor[6] )

inline

These are the basic methods used to define the tensor (these methods coordinate with the overloaded PlaceWidget() method).

The methods enable specification of a 3x3 symmetric tensor. This information is used to construct an oriented, appropriately ellipsoid that is (initially) centered and fits inside the bounding box defined by PlaceWidget(). As this widget is modified during user interaction, the tensor data member is continuously updated and can be queried. Note that a symmetric tensor can be defined with only six components. If a full 3x3 tensor is specified, only the symmetrical part of the tensor is used since the extracted eigenvalues/eigenvecters are required to be real valued. When a tensor is specified, the derived information (e.g., eigenvalues/vectors and position) are immediately updated.

Definition at line 90 of file vtkTensorRepresentation.h.

◆ GetEigenvalues()

void vtkTensorRepresentation::GetEigenvalues ( double evals[3] )

inline

These are methods used to retrieve derived information about the tensor.

Specify (0<=i<3) to retrieve the ith eigenvector. The eigenvalues and associated eigenvectors are sorted in decreasing order.

Definition at line 107 of file vtkTensorRepresentation.h.

◆ GetEigenvector()

void vtkTensorRepresentation::GetEigenvector	(	int	n,
		double	ev[3]
	)

inline

These are methods used to retrieve derived information about the tensor.

Specify (0<=i<3) to retrieve the ith eigenvector. The eigenvalues and associated eigenvectors are sorted in decreasing order.

Definition at line 111 of file vtkTensorRepresentation.h.

◆ SetPosition()

void vtkTensorRepresentation::SetPosition ( double pos[3] )

Set/Get a position for the location of the tensor.

Of course a tensor inherently has no position, but this is for the purpose of placing this widget representation.

◆ GetPosition()

void vtkTensorRepresentation::GetPosition ( double pos[3] )

inline

Set/Get a position for the location of the tensor.

Of course a tensor inherently has no position, but this is for the purpose of placing this widget representation.

Definition at line 125 of file vtkTensorRepresentation.h.

◆ GetPolyData()

void vtkTensorRepresentation::GetPolyData ( vtkPolyData * pd )

Grab the polydata (including points) that define the representation.

The polydata consists of 6 quadrilateral faces and 15 points. The first eight points define the eight corner vertices; the next six define the -x,+x, -y,+y, -z,+z face points; and the final point (the 15th out of 15 points) defines the center of the box. These point values are guaranteed to be up-to-date when either the widget's corresponding InteractionEvent or EndInteractionEvent events are invoked. The user provides the vtkPolyData and the points and cells are added to it.

◆ GetHandleProperty()

virtual vtkProperty * vtkTensorRepresentation::GetHandleProperty ( )

virtual

Get the handle properties (the little balls are the handles).

The properties of the handles, when selected or normal, can be specified.

◆ GetSelectedHandleProperty()

virtual vtkProperty * vtkTensorRepresentation::GetSelectedHandleProperty ( )

virtual

Get the handle properties (the little balls are the handles).

The properties of the handles, when selected or normal, can be specified.

◆ GetFaceProperty()

virtual vtkProperty * vtkTensorRepresentation::GetFaceProperty ( )

virtual

Get the face properties (the faces of the box).

The properties of the face when selected and normal can be set.

◆ GetSelectedFaceProperty()

virtual vtkProperty * vtkTensorRepresentation::GetSelectedFaceProperty ( )

virtual

Get the face properties (the faces of the box).

The properties of the face when selected and normal can be set.

◆ GetOutlineProperty()

virtual vtkProperty * vtkTensorRepresentation::GetOutlineProperty ( )

virtual

Get the outline properties (the outline of the box).

The properties of the outline when selected and normal can be set.

◆ GetSelectedOutlineProperty()

virtual vtkProperty * vtkTensorRepresentation::GetSelectedOutlineProperty ( )

virtual

Get the outline properties (the outline of the box).

The properties of the outline when selected and normal can be set.

◆ GetEllipsoidProperty()

virtual vtkProperty * vtkTensorRepresentation::GetEllipsoidProperty ( )

virtual

Get the tensor ellipsoid properties.

If visibility is enabled, the ellipsoid will be rendered with this property.