VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAbstractPolygonalHandleRepresentation3D Class Reference

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

#include <vtkAbstractPolygonalHandleRepresentation3D.h>

Inheritance diagram for vtkAbstractPolygonalHandleRepresentation3D:
[legend]
Collaboration diagram for vtkAbstractPolygonalHandleRepresentation3D:
[legend]

Public Types

typedef vtkHandleRepresentation Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkHandleRepresentation
enum  _InteractionState {
  Outside = 0, Nearby, Selecting, Translating,
  Scaling
}
 
typedef vtkWidgetRepresentation Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkWidgetRepresentation
enum  Axis { NONE = -1, XAxis = 0, YAxis = 1, ZAxis = 2 }
 Axis labels. More...
 
typedef vtkProp Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkAbstractPolygonalHandleRepresentation3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetWorldPosition (double p[3]) override
 Set the position of the point in world and display coordinates. More...
 
void SetDisplayPosition (double p[3]) override
 Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates. More...
 
void SetHandle (vtkPolyData *)
 Set/get the handle polydata. More...
 
vtkPolyDataGetHandle ()
 
void SetProperty (vtkProperty *)
 Set/Get the handle properties when unselected and selected. More...
 
void SetSelectedProperty (vtkProperty *)
 
virtual vtkPropertyGetProperty ()
 
virtual vtkPropertyGetSelectedProperty ()
 
virtual vtkAbstractTransformGetTransform ()
 Get the transform used to transform the generic handle polydata before placing it in the render window. More...
 
void BuildRepresentation () override
 Methods to make this class properly act like a vtkWidgetRepresentation. More...
 
void StartWidgetInteraction (double eventPos[2]) override
 
void WidgetInteraction (double eventPos[2]) override
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 
void ShallowCopy (vtkProp *prop) override
 Methods to make this class behave as a vtkProp. More...
 
void DeepCopy (vtkProp *prop) override
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More...
 
double * GetBounds () override
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
virtual void SetLabelVisibility (vtkTypeBool)
 A label may be associated with the seed. More...
 
virtual vtkTypeBool GetLabelVisibility ()
 
virtual void LabelVisibilityOn ()
 
virtual void LabelVisibilityOff ()
 
virtual void SetLabelText (const char *label)
 
virtual char * GetLabelText ()
 
virtual void SetLabelTextScale (double scale[3])
 Scale text (font size along each dimension). More...
 
void SetLabelTextScale (double x, double y, double z)
 
virtual double * GetLabelTextScale ()
 
virtual vtkFollowerGetLabelTextActor ()
 Get the label text actor. More...
 
virtual void SetUniformScale (double scale)
 The handle may be scaled uniformly in all three dimensions using this API. More...
 
virtual void SetHandleVisibility (vtkTypeBool)
 Toggle the visibility of the handle on and off. More...
 
virtual vtkTypeBool GetHandleVisibility ()
 
virtual void HandleVisibilityOn ()
 
virtual void HandleVisibilityOff ()
 
void Highlight (int highlight) override
 
virtual void SetSmoothMotion (vtkTypeBool)
 Turn on/off smooth motion of the handle. More...
 
virtual vtkTypeBool GetSmoothMotion ()
 
virtual void SmoothMotionOn ()
 
virtual void SmoothMotionOff ()
 
void RegisterPickers () override
 Register internal Pickers in the Picking Manager. More...
 
virtual void Translate (const double *p1, const double *p2)
 Translates world position by vector p1p2 projected on the constraint axis if any. More...
 
virtual void Translate (const double *v)
 Translates world position by vector v projected on the constraint axis if any. More...
 
- Public Member Functions inherited from vtkHandleRepresentation
vtkHandleRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void GetDisplayPosition (double pos[3])
 
virtual double * GetDisplayPosition ()
 
virtual void GetWorldPosition (double pos[3])
 
virtual double * GetWorldPosition ()
 
virtual void SetTolerance (int)
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the widget to be active. More...
 
virtual int GetTolerance ()
 
virtual void SetActiveRepresentation (vtkTypeBool)
 Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active). More...
 
virtual vtkTypeBool GetActiveRepresentation ()
 
virtual void ActiveRepresentationOn ()
 
virtual void ActiveRepresentationOff ()
 
virtual void SetInteractionState (int)
 The interaction state may be set from a widget (e.g., HandleWidget) or other object. More...
 
virtual void SetConstrained (vtkTypeBool)
 Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion. More...
 
virtual vtkTypeBool GetConstrained ()
 
virtual void ConstrainedOn ()
 
virtual void ConstrainedOff ()
 
virtual int CheckConstraint (vtkRenderer *renderer, double pos[2])
 Method has to be overridden in the subclasses which has constraints on placing the handle (Ex. More...
 
void ShallowCopy (vtkProp *prop) override
 Methods to make this class properly act like a vtkWidgetRepresentation. More...
 
void SetRenderer (vtkRenderer *ren) override
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
vtkMTimeType GetMTime () override
 Overload the superclasses' GetMTime() because the internal vtkCoordinates are used to keep the state of the representation. More...
 
virtual void SetPointPlacer (vtkPointPlacer *)
 Set/Get the point placer. More...
 
virtual vtkPointPlacerGetPointPlacer ()
 
virtual void GetTranslationVector (const double *p1, const double *p2, double *v) const
 Gets the translation vector. More...
 
virtual void Translate (const double *v)
 Translates world position by vector v projected on the constraint axis if any. More...
 
virtual int GetTranslationAxis ()
 Gets/Sets the constraint axis for translations. More...
 
virtual void SetTranslationAxis (int)
 
void SetXTranslationAxisOn ()
 Toggles constraint translation axis on/off. More...
 
void SetYTranslationAxisOn ()
 
void SetZTranslationAxisOn ()
 
void SetTranslationAxisOff ()
 
bool IsTranslationConstrained ()
 Returns true if ContrainedAxis. More...
 
- Public Member Functions inherited from vtkWidgetRepresentation
vtkWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 
void SetPickingManaged (bool managed)
 
virtual bool GetPickingManaged ()
 
virtual vtkRendererGetRenderer ()
 
virtual void PlaceWidget (double *vtkNotUsed(bounds[6]))
 The following is a suggested API for widget representations. More...
 
virtual void EndWidgetInteraction (double newEventPos[2])
 
virtual int GetInteractionState ()
 
virtual void Highlight (int vtkNotUsed(highlightOn))
 
virtual void StartComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual void ComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual void EndComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual int ComputeComplexInteractionState (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *callData, int modify=0)
 
virtual void SetPlaceFactor (double)
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
virtual double GetPlaceFactor ()
 
virtual void SetHandleSize (double)
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...
 
virtual double GetHandleSize ()
 
virtual vtkTypeBool GetNeedToRender ()
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...
 
virtual void SetNeedToRender (vtkTypeBool)
 
virtual void NeedToRenderOn ()
 
virtual void NeedToRenderOff ()
 
double * GetBounds () override
 Methods to make this class behave as a vtkProp. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp. More...
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
void GetActors2D (vtkPropCollection *) override
 
void GetVolumes (vtkPropCollection *) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...
 
int RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More...
 
virtual void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 
virtual void VisibilityOn ()
 
virtual void VisibilityOff ()
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 
virtual void PickableOn ()
 
virtual void PickableOff ()
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 
virtual void DragableOn ()
 
virtual void DragableOff ()
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
virtual void SetUseBounds (bool)
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual bool GetUseBounds ()
 
virtual void UseBoundsOn ()
 
virtual void UseBoundsOff ()
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkAssemblyPathGetNextPath ()
 
virtual int GetNumberOfPaths ()
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual int RenderOverlay (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
virtual 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. More...
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...
 
virtual void RestoreEstimatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
void SetRenderTimeMultiplier (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...
 
virtual bool GetSupportsSelection ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 
vtkObjectGetConsumer (int i)
 
int IsConsumer (vtkObject *c)
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractPolygonalHandleRepresentation3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkHandleRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHandleRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractPolygonalHandleRepresentation3D ()
 
 ~vtkAbstractPolygonalHandleRepresentation3D () override
 
virtual void Translate (const double *p1, const double *p2) override
 Translates world position by vector p1p2 projected on the constraint axis if any. More...
 
virtual void Scale (const double *p1, const double *p2, const double eventPos[2])
 
virtual void MoveFocus (const double *p1, const double *p2)
 
void CreateDefaultProperties ()
 
void MoveFocusRequest (const double *p1, const double *p2, const double eventPos[2], double requestedDisplayPos[3])
 
int DetermineConstraintAxis (int constraint, double *x, double *startPickPos)
 
virtual void UpdateHandle ()
 Update the actor position. More...
 
virtual void UpdateLabel ()
 Opportunity to update the label position and text during each render. More...
 
- Protected Member Functions inherited from vtkHandleRepresentation
 vtkHandleRepresentation ()
 
 ~vtkHandleRepresentation () override
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation () override
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the widget representation currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path. More...
 
vtkAssemblyPathGetAssemblyPath3DPoint (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
 vtkProp ()
 
 ~vtkProp () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkActorActor
 
vtkPolyDataMapperMapper
 
vtkTransformPolyDataFilterHandleTransformFilter
 
vtkMatrixToLinearTransformHandleTransform
 
vtkMatrix4x4HandleTransformMatrix
 
vtkCellPickerHandlePicker
 
double LastPickPosition [3]
 
double LastEventPosition [2]
 
int ConstraintAxis
 
vtkPropertyProperty
 
vtkPropertySelectedProperty
 
int WaitingForMotion
 
int WaitCount
 
vtkTypeBool HandleVisibility
 
vtkTypeBool LabelVisibility
 
vtkFollowerLabelTextActor
 
vtkPolyDataMapperLabelTextMapper
 
vtkVectorTextLabelTextInput
 
bool LabelAnnotationTextScaleInitialized
 
vtkTypeBool SmoothMotion
 
- Protected Attributes inherited from vtkHandleRepresentation
int Tolerance
 
vtkTypeBool ActiveRepresentation
 
vtkTypeBool Constrained
 
vtkCoordinateDisplayPosition
 
vtkCoordinateWorldPosition
 
vtkTimeStamp DisplayPositionTime
 
vtkTimeStamp WorldPositionTime
 
vtkPointPlacerPointPlacer
 
int TranslationAxis
 
- Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRendererRenderer
 
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< vtkTransformTempTransform
 
vtkNew< vtkMatrix4x4TempMatrix
 
- 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
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

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

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

See also
vtkPolygonalHandleRepresentation3D vtkHandleRepresentation vtkHandleWidget

Definition at line 50 of file vtkAbstractPolygonalHandleRepresentation3D.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 58 of file vtkAbstractPolygonalHandleRepresentation3D.h.

Constructor & Destructor Documentation

◆ vtkAbstractPolygonalHandleRepresentation3D()

vtkAbstractPolygonalHandleRepresentation3D::vtkAbstractPolygonalHandleRepresentation3D ( )
protected

◆ ~vtkAbstractPolygonalHandleRepresentation3D()

vtkAbstractPolygonalHandleRepresentation3D::~vtkAbstractPolygonalHandleRepresentation3D ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkAbstractPolygonalHandleRepresentation3D::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractPolygonalHandleRepresentation3D::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkAbstractPolygonalHandleRepresentation3D* vtkAbstractPolygonalHandleRepresentation3D::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractPolygonalHandleRepresentation3D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkFixedSizeHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.

◆ SetWorldPosition()

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

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

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkPolygonalHandleRepresentation3D.

◆ SetDisplayPosition()

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

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

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

Reimplemented from vtkHandleRepresentation.

◆ SetHandle()

void vtkAbstractPolygonalHandleRepresentation3D::SetHandle ( vtkPolyData )

Set/get the handle polydata.

◆ GetHandle()

vtkPolyData* vtkAbstractPolygonalHandleRepresentation3D::GetHandle ( )

◆ SetProperty()

void vtkAbstractPolygonalHandleRepresentation3D::SetProperty ( vtkProperty )

Set/Get the handle properties when unselected and selected.

◆ SetSelectedProperty()

void vtkAbstractPolygonalHandleRepresentation3D::SetSelectedProperty ( vtkProperty )

◆ GetProperty()

virtual vtkProperty* vtkAbstractPolygonalHandleRepresentation3D::GetProperty ( )
virtual

◆ GetSelectedProperty()

virtual vtkProperty* vtkAbstractPolygonalHandleRepresentation3D::GetSelectedProperty ( )
virtual

◆ GetTransform()

virtual vtkAbstractTransform* vtkAbstractPolygonalHandleRepresentation3D::GetTransform ( )
virtual

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

◆ BuildRepresentation()

void vtkAbstractPolygonalHandleRepresentation3D::BuildRepresentation ( )
overridevirtual

Methods to make this class properly act like a vtkWidgetRepresentation.

Implements vtkWidgetRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D.

◆ StartWidgetInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ WidgetInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ ComputeInteractionState()

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

Reimplemented from vtkWidgetRepresentation.

◆ ShallowCopy()

void vtkAbstractPolygonalHandleRepresentation3D::ShallowCopy ( vtkProp prop)
overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

◆ DeepCopy()

void vtkAbstractPolygonalHandleRepresentation3D::DeepCopy ( vtkProp prop)
overridevirtual

Reimplemented from vtkHandleRepresentation.

◆ GetActors()

void vtkAbstractPolygonalHandleRepresentation3D::GetActors ( vtkPropCollection )
overridevirtual

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

These methods are used in that process.

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkAbstractPolygonalHandleRepresentation3D::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

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

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

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkAbstractPolygonalHandleRepresentation3D::RenderOpaqueGeometry ( vtkViewport )
overridevirtual

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

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

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkAbstractPolygonalHandleRepresentation3D::RenderTranslucentPolygonalGeometry ( vtkViewport viewport)
overridevirtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkAbstractPolygonalHandleRepresentation3D::HasTranslucentPolygonalGeometry ( )
overridevirtual

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

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

Reimplemented from vtkProp.

◆ GetBounds()

double* vtkAbstractPolygonalHandleRepresentation3D::GetBounds ( void  )
overridevirtual

Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

in world coordinates. NULL means that the bounds are not defined.

Reimplemented from vtkProp.

◆ SetLabelVisibility()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetLabelVisibility ( vtkTypeBool  )
virtual

A label may be associated with the seed.

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

◆ GetLabelVisibility()

virtual vtkTypeBool vtkAbstractPolygonalHandleRepresentation3D::GetLabelVisibility ( )
virtual

◆ LabelVisibilityOn()

virtual void vtkAbstractPolygonalHandleRepresentation3D::LabelVisibilityOn ( )
virtual

◆ LabelVisibilityOff()

virtual void vtkAbstractPolygonalHandleRepresentation3D::LabelVisibilityOff ( )
virtual

◆ SetLabelText()

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

◆ GetLabelText()

virtual char* vtkAbstractPolygonalHandleRepresentation3D::GetLabelText ( )
virtual

◆ SetLabelTextScale() [1/2]

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

Scale text (font size along each dimension).

◆ SetLabelTextScale() [2/2]

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

◆ GetLabelTextScale()

virtual double* vtkAbstractPolygonalHandleRepresentation3D::GetLabelTextScale ( )
virtual

◆ GetLabelTextActor()

virtual vtkFollower* vtkAbstractPolygonalHandleRepresentation3D::GetLabelTextActor ( )
virtual

Get the label text actor.

◆ SetUniformScale()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetUniformScale ( double  scale)
virtual

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

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

◆ SetHandleVisibility()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetHandleVisibility ( vtkTypeBool  )
virtual

Toggle the visibility of the handle on and off.

◆ GetHandleVisibility()

virtual vtkTypeBool vtkAbstractPolygonalHandleRepresentation3D::GetHandleVisibility ( )
virtual

◆ HandleVisibilityOn()

virtual void vtkAbstractPolygonalHandleRepresentation3D::HandleVisibilityOn ( )
virtual

◆ HandleVisibilityOff()

virtual void vtkAbstractPolygonalHandleRepresentation3D::HandleVisibilityOff ( )
virtual

◆ Highlight()

void vtkAbstractPolygonalHandleRepresentation3D::Highlight ( int  highlight)
override

◆ SetSmoothMotion()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetSmoothMotion ( vtkTypeBool  )
virtual

Turn on/off smooth motion of the handle.

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

◆ GetSmoothMotion()

virtual vtkTypeBool vtkAbstractPolygonalHandleRepresentation3D::GetSmoothMotion ( )
virtual

◆ SmoothMotionOn()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SmoothMotionOn ( )
virtual

◆ SmoothMotionOff()

virtual void vtkAbstractPolygonalHandleRepresentation3D::SmoothMotionOff ( )
virtual

◆ RegisterPickers()

void vtkAbstractPolygonalHandleRepresentation3D::RegisterPickers ( )
overridevirtual

Register internal Pickers in the Picking Manager.

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

Reimplemented from vtkWidgetRepresentation.

◆ Translate() [1/3]

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

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

Reimplemented from vtkHandleRepresentation.

◆ Scale()

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

◆ MoveFocus()

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

◆ CreateDefaultProperties()

void vtkAbstractPolygonalHandleRepresentation3D::CreateDefaultProperties ( )
protected

◆ MoveFocusRequest()

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

◆ DetermineConstraintAxis()

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

◆ UpdateHandle()

virtual void vtkAbstractPolygonalHandleRepresentation3D::UpdateHandle ( )
protectedvirtual

Update the actor position.

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

Reimplemented in vtkOrientedPolygonalHandleRepresentation3D.

◆ UpdateLabel()

virtual void vtkAbstractPolygonalHandleRepresentation3D::UpdateLabel ( )
protectedvirtual

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

◆ Translate() [2/3]

virtual void vtkHandleRepresentation::Translate

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

◆ Translate() [3/3]

virtual void vtkHandleRepresentation::Translate

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

Member Data Documentation

◆ Actor

vtkActor* vtkAbstractPolygonalHandleRepresentation3D::Actor
protected

◆ Mapper

vtkPolyDataMapper* vtkAbstractPolygonalHandleRepresentation3D::Mapper
protected

◆ HandleTransformFilter

vtkTransformPolyDataFilter* vtkAbstractPolygonalHandleRepresentation3D::HandleTransformFilter
protected

◆ HandleTransform

vtkMatrixToLinearTransform* vtkAbstractPolygonalHandleRepresentation3D::HandleTransform
protected

◆ HandleTransformMatrix

vtkMatrix4x4* vtkAbstractPolygonalHandleRepresentation3D::HandleTransformMatrix
protected

◆ HandlePicker

vtkCellPicker* vtkAbstractPolygonalHandleRepresentation3D::HandlePicker
protected

◆ LastPickPosition

double vtkAbstractPolygonalHandleRepresentation3D::LastPickPosition[3]
protected

◆ LastEventPosition

double vtkAbstractPolygonalHandleRepresentation3D::LastEventPosition[2]
protected

◆ ConstraintAxis

int vtkAbstractPolygonalHandleRepresentation3D::ConstraintAxis
protected

◆ Property

vtkProperty* vtkAbstractPolygonalHandleRepresentation3D::Property
protected

◆ SelectedProperty

vtkProperty* vtkAbstractPolygonalHandleRepresentation3D::SelectedProperty
protected

◆ WaitingForMotion

int vtkAbstractPolygonalHandleRepresentation3D::WaitingForMotion
protected

◆ WaitCount

int vtkAbstractPolygonalHandleRepresentation3D::WaitCount
protected

◆ HandleVisibility

vtkTypeBool vtkAbstractPolygonalHandleRepresentation3D::HandleVisibility
protected

◆ LabelVisibility

vtkTypeBool vtkAbstractPolygonalHandleRepresentation3D::LabelVisibility
protected

◆ LabelTextActor

vtkFollower* vtkAbstractPolygonalHandleRepresentation3D::LabelTextActor
protected

◆ LabelTextMapper

vtkPolyDataMapper* vtkAbstractPolygonalHandleRepresentation3D::LabelTextMapper
protected

◆ LabelTextInput

vtkVectorText* vtkAbstractPolygonalHandleRepresentation3D::LabelTextInput
protected

◆ LabelAnnotationTextScaleInitialized

bool vtkAbstractPolygonalHandleRepresentation3D::LabelAnnotationTextScaleInitialized
protected

◆ SmoothMotion

vtkTypeBool vtkAbstractPolygonalHandleRepresentation3D::SmoothMotion
protected

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