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

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

#include <vtkConstrainedPointHandleRepresentation.h>

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

Public Types

enum  { XAxis = 0, YAxis, ZAxis, Oblique }
 
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...
 
vtkConstrainedPointHandleRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetCursorShape (vtkPolyData *cursorShape)
 Specify the cursor shape. More...
 
vtkPolyDataGetCursorShape ()
 
void SetActiveCursorShape (vtkPolyData *activeShape)
 Specify the shape of the cursor (handle) when it is active. More...
 
vtkPolyDataGetActiveCursorShape ()
 
virtual void SetProjectionNormal (int)
 Set the projection normal to lie along the x, y, or z axis, or to be oblique. More...
 
virtual int GetProjectionNormal ()
 
void SetProjectionNormalToXAxis ()
 
void SetProjectionNormalToYAxis ()
 
void SetProjectionNormalToZAxis ()
 
void SetProjectionNormalToOblique ()
 
void SetObliquePlane (vtkPlane *)
 If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position. More...
 
virtual vtkPlaneGetObliquePlane ()
 
void SetProjectionPosition (double position)
 The position of the bounding plane from the origin along the normal. More...
 
virtual double GetProjectionPosition ()
 
void AddBoundingPlane (vtkPlane *plane)
 A collection of plane equations used to bound the position of the point. More...
 
void RemoveBoundingPlane (vtkPlane *plane)
 
void RemoveAllBoundingPlanes ()
 
virtual void SetBoundingPlanes (vtkPlaneCollection *)
 
virtual vtkPlaneCollectionGetBoundingPlanes ()
 
void SetBoundingPlanes (vtkPlanes *planes)
 
int CheckConstraint (vtkRenderer *renderer, double pos[2]) override
 Overridden from the base class. More...
 
void SetPosition (double x, double y, double z)
 Set/Get the position of the point in display coordinates. More...
 
void SetPosition (double xyz[3])
 
double * GetPosition ()
 
void GetPosition (double xyz[3])
 
virtual vtkPropertyGetProperty ()
 This is the property used when the handle is not active (the mouse is not near the handle) More...
 
virtual vtkPropertyGetSelectedProperty ()
 This is the property used when the mouse is near the handle (but the user is not yet interacting with it) More...
 
virtual vtkPropertyGetActiveProperty ()
 This is the property used when the user is interacting with the handle. More...
 
void SetRenderer (vtkRenderer *ren) override
 Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods. More...
 
void BuildRepresentation () override
 
void StartWidgetInteraction (double eventPos[2]) override
 
void WidgetInteraction (double eventPos[2]) override
 
int ComputeInteractionState (int X, int Y, int modify) override
 
void SetDisplayPosition (double pos[3]) override
 Method overridden from Superclass. More...
 
void GetActors (vtkPropCollection *) override
 Methods to make this class behave as a vtkProp. 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 RenderOverlay (vtkViewport *viewport) override
 
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...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp. More...
 
void Highlight (int highlight) override
 
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 SetWorldPosition (double pos[3])
 
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 ()
 
void ShallowCopy (vtkProp *prop) override
 Methods to make this class properly act like a vtkWidgetRepresentation. More...
 
virtual void DeepCopy (vtkProp *prop)
 
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 *p1, const double *p2)
 Translates world position by vector p1p2 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 RegisterPickers ()
 Register internal Pickers in the Picking Manager. 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 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 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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkConstrainedPointHandleRepresentationNew ()
 Instantiate this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkConstrainedPointHandleRepresentationSafeDownCast (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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkConstrainedPointHandleRepresentation ()
 
 ~vtkConstrainedPointHandleRepresentation () override
 
void Translate (const double *eventPos) override
 Translates world position by vector v projected on the constraint axis if any. More...
 
void Scale (const double *eventPos)
 
void CreateDefaultProperties ()
 
int GetIntersectionPosition (const double eventPos[2], double worldPos[3], double tolerance=0.0, vtkRenderer *renderer=nullptr)
 
void GetProjectionNormal (double normal[3])
 
void GetProjectionOrigin (double origin[3])
 
- Protected Member Functions inherited from vtkHandleRepresentation
 vtkHandleRepresentation ()
 
 ~vtkHandleRepresentation () override
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation () override
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkActorActor
 
vtkPolyDataMapperMapper
 
vtkGlyph3DGlypher
 
vtkPolyDataCursorShape
 
vtkPolyDataActiveCursorShape
 
vtkPolyDataFocalData
 
vtkPointsFocalPoint
 
double LastPickPosition [3]
 
double LastEventPosition [2]
 
vtkPropertyProperty
 
vtkPropertySelectedProperty
 
vtkPropertyActiveProperty
 
int ProjectionNormal
 
double ProjectionPosition
 
int ProjectToPlane
 
vtkPlaneObliquePlane
 
vtkPlaneCollectionBoundingPlanes
 
double InteractionOffset [2]
 
- 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
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

point representation constrained to a 2D plane

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

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

See also
vtkHandleRepresentation vtkHandleWidget

Definition at line 55 of file vtkConstrainedPointHandleRepresentation.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 68 of file vtkConstrainedPointHandleRepresentation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
XAxis 
YAxis 
ZAxis 
Oblique 

Definition at line 235 of file vtkConstrainedPointHandleRepresentation.h.

Constructor & Destructor Documentation

◆ vtkConstrainedPointHandleRepresentation()

vtkConstrainedPointHandleRepresentation::vtkConstrainedPointHandleRepresentation ( )
protected

◆ ~vtkConstrainedPointHandleRepresentation()

vtkConstrainedPointHandleRepresentation::~vtkConstrainedPointHandleRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkConstrainedPointHandleRepresentation* vtkConstrainedPointHandleRepresentation::New ( )
static

Instantiate this class.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkConstrainedPointHandleRepresentation::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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkConstrainedPointHandleRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkHandleRepresentation.

◆ NewInstance()

vtkConstrainedPointHandleRepresentation* vtkConstrainedPointHandleRepresentation::NewInstance ( ) const

◆ PrintSelf()

void vtkConstrainedPointHandleRepresentation::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.

◆ SetCursorShape()

void vtkConstrainedPointHandleRepresentation::SetCursorShape ( vtkPolyData cursorShape)

Specify the cursor shape.

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

◆ GetCursorShape()

vtkPolyData* vtkConstrainedPointHandleRepresentation::GetCursorShape ( )

◆ SetActiveCursorShape()

void vtkConstrainedPointHandleRepresentation::SetActiveCursorShape ( vtkPolyData activeShape)

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

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

◆ GetActiveCursorShape()

vtkPolyData* vtkConstrainedPointHandleRepresentation::GetActiveCursorShape ( )

◆ SetProjectionNormal()

virtual void vtkConstrainedPointHandleRepresentation::SetProjectionNormal ( int  )
virtual

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

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

◆ GetProjectionNormal() [1/2]

virtual int vtkConstrainedPointHandleRepresentation::GetProjectionNormal ( )
virtual

◆ SetProjectionNormalToXAxis()

void vtkConstrainedPointHandleRepresentation::SetProjectionNormalToXAxis ( )
inline

Definition at line 105 of file vtkConstrainedPointHandleRepresentation.h.

◆ SetProjectionNormalToYAxis()

void vtkConstrainedPointHandleRepresentation::SetProjectionNormalToYAxis ( )
inline

Definition at line 109 of file vtkConstrainedPointHandleRepresentation.h.

◆ SetProjectionNormalToZAxis()

void vtkConstrainedPointHandleRepresentation::SetProjectionNormalToZAxis ( )
inline

Definition at line 113 of file vtkConstrainedPointHandleRepresentation.h.

◆ SetProjectionNormalToOblique()

void vtkConstrainedPointHandleRepresentation::SetProjectionNormalToOblique ( )
inline

Definition at line 117 of file vtkConstrainedPointHandleRepresentation.h.

◆ SetObliquePlane()

void vtkConstrainedPointHandleRepresentation::SetObliquePlane ( vtkPlane )

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

◆ GetObliquePlane()

virtual vtkPlane* vtkConstrainedPointHandleRepresentation::GetObliquePlane ( )
virtual

◆ SetProjectionPosition()

void vtkConstrainedPointHandleRepresentation::SetProjectionPosition ( double  position)

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

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

◆ GetProjectionPosition()

virtual double vtkConstrainedPointHandleRepresentation::GetProjectionPosition ( )
virtual

◆ AddBoundingPlane()

void vtkConstrainedPointHandleRepresentation::AddBoundingPlane ( vtkPlane plane)

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

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

◆ RemoveBoundingPlane()

void vtkConstrainedPointHandleRepresentation::RemoveBoundingPlane ( vtkPlane plane)

◆ RemoveAllBoundingPlanes()

void vtkConstrainedPointHandleRepresentation::RemoveAllBoundingPlanes ( )

◆ SetBoundingPlanes() [1/2]

virtual void vtkConstrainedPointHandleRepresentation::SetBoundingPlanes ( vtkPlaneCollection )
virtual

◆ GetBoundingPlanes()

virtual vtkPlaneCollection* vtkConstrainedPointHandleRepresentation::GetBoundingPlanes ( )
virtual

◆ SetBoundingPlanes() [2/2]

void vtkConstrainedPointHandleRepresentation::SetBoundingPlanes ( vtkPlanes planes)

◆ CheckConstraint()

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

Overridden from the base class.

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

Reimplemented from vtkHandleRepresentation.

◆ SetPosition() [1/2]

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

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

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

◆ SetPosition() [2/2]

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

◆ GetPosition() [1/2]

double* vtkConstrainedPointHandleRepresentation::GetPosition ( )

◆ GetPosition() [2/2]

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

◆ GetProperty()

virtual vtkProperty* vtkConstrainedPointHandleRepresentation::GetProperty ( )
virtual

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

◆ GetSelectedProperty()

virtual vtkProperty* vtkConstrainedPointHandleRepresentation::GetSelectedProperty ( )
virtual

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

◆ GetActiveProperty()

virtual vtkProperty* vtkConstrainedPointHandleRepresentation::GetActiveProperty ( )
virtual

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

◆ SetRenderer()

void vtkConstrainedPointHandleRepresentation::SetRenderer ( vtkRenderer ren)
overridevirtual

Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods.

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

Reimplemented from vtkWidgetRepresentation.

◆ BuildRepresentation()

void vtkConstrainedPointHandleRepresentation::BuildRepresentation ( )
overridevirtual

◆ StartWidgetInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ WidgetInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ ComputeInteractionState()

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

Reimplemented from vtkWidgetRepresentation.

◆ SetDisplayPosition()

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

Method overridden from Superclass.

computes the world co-ordinates using GetIntersectionPosition()

Reimplemented from vtkHandleRepresentation.

◆ GetActors()

void vtkConstrainedPointHandleRepresentation::GetActors ( vtkPropCollection )
overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkConstrainedPointHandleRepresentation::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.

◆ RenderOverlay()

int vtkConstrainedPointHandleRepresentation::RenderOverlay ( vtkViewport viewport)
overridevirtual

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkConstrainedPointHandleRepresentation::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 vtkConstrainedPointHandleRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport viewport)
overridevirtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

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

◆ ShallowCopy()

void vtkConstrainedPointHandleRepresentation::ShallowCopy ( vtkProp prop)
overridevirtual

Shallow copy of this vtkProp.

Reimplemented from vtkProp.

◆ Highlight()

void vtkConstrainedPointHandleRepresentation::Highlight ( int  highlight)
override

◆ Translate() [1/3]

void vtkConstrainedPointHandleRepresentation::Translate ( const double *  v)
overrideprotectedvirtual

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

Reimplemented from vtkHandleRepresentation.

◆ Scale()

void vtkConstrainedPointHandleRepresentation::Scale ( const double *  eventPos)
protected

◆ CreateDefaultProperties()

void vtkConstrainedPointHandleRepresentation::CreateDefaultProperties ( )
protected

◆ GetIntersectionPosition()

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

◆ GetProjectionNormal() [2/2]

void vtkConstrainedPointHandleRepresentation::GetProjectionNormal ( double  normal[3])
protected

◆ GetProjectionOrigin()

void vtkConstrainedPointHandleRepresentation::GetProjectionOrigin ( double  origin[3])
protected

◆ 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* vtkConstrainedPointHandleRepresentation::Actor
protected

Definition at line 250 of file vtkConstrainedPointHandleRepresentation.h.

◆ Mapper

vtkPolyDataMapper* vtkConstrainedPointHandleRepresentation::Mapper
protected

Definition at line 251 of file vtkConstrainedPointHandleRepresentation.h.

◆ Glypher

vtkGlyph3D* vtkConstrainedPointHandleRepresentation::Glypher
protected

Definition at line 252 of file vtkConstrainedPointHandleRepresentation.h.

◆ CursorShape

vtkPolyData* vtkConstrainedPointHandleRepresentation::CursorShape
protected

Definition at line 253 of file vtkConstrainedPointHandleRepresentation.h.

◆ ActiveCursorShape

vtkPolyData* vtkConstrainedPointHandleRepresentation::ActiveCursorShape
protected

Definition at line 254 of file vtkConstrainedPointHandleRepresentation.h.

◆ FocalData

vtkPolyData* vtkConstrainedPointHandleRepresentation::FocalData
protected

Definition at line 255 of file vtkConstrainedPointHandleRepresentation.h.

◆ FocalPoint

vtkPoints* vtkConstrainedPointHandleRepresentation::FocalPoint
protected

Definition at line 256 of file vtkConstrainedPointHandleRepresentation.h.

◆ LastPickPosition

double vtkConstrainedPointHandleRepresentation::LastPickPosition[3]
protected

Definition at line 259 of file vtkConstrainedPointHandleRepresentation.h.

◆ LastEventPosition

double vtkConstrainedPointHandleRepresentation::LastEventPosition[2]
protected

Definition at line 260 of file vtkConstrainedPointHandleRepresentation.h.

◆ Property

vtkProperty* vtkConstrainedPointHandleRepresentation::Property
protected

Definition at line 268 of file vtkConstrainedPointHandleRepresentation.h.

◆ SelectedProperty

vtkProperty* vtkConstrainedPointHandleRepresentation::SelectedProperty
protected

Definition at line 269 of file vtkConstrainedPointHandleRepresentation.h.

◆ ActiveProperty

vtkProperty* vtkConstrainedPointHandleRepresentation::ActiveProperty
protected

Definition at line 270 of file vtkConstrainedPointHandleRepresentation.h.

◆ ProjectionNormal

int vtkConstrainedPointHandleRepresentation::ProjectionNormal
protected

Definition at line 274 of file vtkConstrainedPointHandleRepresentation.h.

◆ ProjectionPosition

double vtkConstrainedPointHandleRepresentation::ProjectionPosition
protected

Definition at line 275 of file vtkConstrainedPointHandleRepresentation.h.

◆ ProjectToPlane

int vtkConstrainedPointHandleRepresentation::ProjectToPlane
protected

Definition at line 276 of file vtkConstrainedPointHandleRepresentation.h.

◆ ObliquePlane

vtkPlane* vtkConstrainedPointHandleRepresentation::ObliquePlane
protected

Definition at line 277 of file vtkConstrainedPointHandleRepresentation.h.

◆ BoundingPlanes

vtkPlaneCollection* vtkConstrainedPointHandleRepresentation::BoundingPlanes
protected

Definition at line 279 of file vtkConstrainedPointHandleRepresentation.h.

◆ InteractionOffset

double vtkConstrainedPointHandleRepresentation::InteractionOffset[2]
protected

Definition at line 294 of file vtkConstrainedPointHandleRepresentation.h.


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