VTK
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkBiDimensionalRepresentation Class Referenceabstract

represent the vtkBiDimensionalWidget More...

#include <vtkBiDimensionalRepresentation.h>

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

Public Types

enum  {
  Outside =0, NearP1, NearP2, NearP3,
  NearP4, OnL1Inner, OnL1Outer, OnL2Inner,
  OnL2Outer, OnCenter
}
 
- Public Types inherited from vtkWidgetRepresentation
typedef vtkProp Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual double GetLength1 ()
 Return the length of the line defined by (Point1,Point2). More...
 
virtual double GetLength2 ()
 Return the length of the line defined by (Point3,Point4). More...
 
virtual char * GetLabelText ()=0
 Get the text shown in the widget's label. More...
 
virtual void SetPoint1WorldPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void SetPoint2WorldPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void SetPoint3WorldPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void SetPoint4WorldPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void GetPoint1WorldPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void GetPoint2WorldPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void GetPoint3WorldPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void GetPoint4WorldPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void SetPoint1DisplayPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void SetPoint2DisplayPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void SetPoint3DisplayPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void SetPoint4DisplayPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void GetPoint1DisplayPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void GetPoint2DisplayPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void GetPoint3DisplayPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual void GetPoint4DisplayPosition (double pos[3])
 Methods to Set/Get the coordinates of the four points defining this representation. More...
 
virtual vtkHandleRepresentationGetPoint1Representation ()
 Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D. More...
 
virtual vtkHandleRepresentationGetPoint2Representation ()
 Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D. More...
 
virtual vtkHandleRepresentationGetPoint3Representation ()
 Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D. More...
 
virtual vtkHandleRepresentationGetPoint4Representation ()
 Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D. More...
 
virtual void SetLine1Visibility (vtkTypeBool)
 Special methods for turning off the lines that define the bi-dimensional measure. More...
 
virtual vtkTypeBool GetLine1Visibility ()
 Special methods for turning off the lines that define the bi-dimensional measure. More...
 
virtual void Line1VisibilityOn ()
 Special methods for turning off the lines that define the bi-dimensional measure. More...
 
virtual void Line1VisibilityOff ()
 Special methods for turning off the lines that define the bi-dimensional measure. More...
 
virtual void SetLine2Visibility (vtkTypeBool)
 Special methods for turning off the lines that define the bi-dimensional measure. More...
 
virtual vtkTypeBool GetLine2Visibility ()
 Special methods for turning off the lines that define the bi-dimensional measure. More...
 
virtual void Line2VisibilityOn ()
 Special methods for turning off the lines that define the bi-dimensional measure. More...
 
virtual void Line2VisibilityOff ()
 Special methods for turning off the lines that define the bi-dimensional measure. More...
 
void SetHandleRepresentation (vtkHandleRepresentation *handle)
 This method is used to specify the type of handle representation to use for the four internal vtkHandleRepresentations within vtkBiDimensionalRepresentation. More...
 
virtual void InstantiateHandleRepresentation ()
 This method is used to specify the type of handle representation to use for the four internal vtkHandleRepresentations within vtkBiDimensionalRepresentation. More...
 
virtual void SetTolerance (int)
 The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the representation to be active. More...
 
virtual int GetTolerance ()
 The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the representation to be active. More...
 
virtual void SetLabelFormat (const char *)
 Specify the format to use for labelling the distance. More...
 
virtual char * GetLabelFormat ()
 Specify the format to use for labelling the distance. More...
 
virtual void SetShowLabelAboveWidget (vtkTypeBool)
 Toggle whether to display the label above or below the widget. More...
 
virtual vtkTypeBool GetShowLabelAboveWidget ()
 Toggle whether to display the label above or below the widget. More...
 
virtual void ShowLabelAboveWidgetOn ()
 Toggle whether to display the label above or below the widget. More...
 
virtual void ShowLabelAboveWidgetOff ()
 Toggle whether to display the label above or below the widget. More...
 
void SetID (vtkIdType id)
 Set/get the id to display in the label. More...
 
virtual vtkIdType GetID ()
 Set/get the id to display in the label. More...
 
virtual doubleGetLabelPosition ()=0
 Get the position of the widget's label in display coordinates. More...
 
virtual void GetLabelPosition (double pos[3])=0
 Get the position of the widget's label in display coordinates. More...
 
virtual void GetWorldLabelPosition (double pos[3])=0
 Get the position of the widget's label in display coordinates. More...
 
virtual void StartWidgetDefinition (double e[2])=0
 These are methods that satisfy vtkWidgetRepresentation's API. More...
 
virtual void Point2WidgetInteraction (double e[2])=0
 These are methods that satisfy vtkWidgetRepresentation's API. More...
 
virtual void Point3WidgetInteraction (double e[2])=0
 These are methods that satisfy vtkWidgetRepresentation's API. More...
 
virtual void StartWidgetManipulation (double e[2])=0
 These are methods that satisfy vtkWidgetRepresentation's API. More...
 
- Public Member Functions inherited from vtkWidgetRepresentation
virtual void PlaceWidget (double *vtkNotUsed(bounds[6]))
 The following is a suggested API for widget representations. More...
 
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))
 
doubleGetBounds () 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...
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 Enable/Disable the use of a manager to process the picking. More...
 
void SetPickingManaged (bool managed)
 Enable/Disable the use of a manager to process the picking. More...
 
virtual bool GetPickingManaged ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetRenderer (vtkRenderer *ren)
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
virtual vtkRendererGetRenderer ()
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
virtual void BuildRepresentation ()=0
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
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 ()
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
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 ()
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...
 
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)
 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 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). More...
 
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). More...
 
vtkWidgetRepresentationNewInstance () const
 Standard methods for instances of this class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instances of this class. 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 Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
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 bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
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. More...
 
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. 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 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...
 
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 void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp. More...
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOn ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOff ()
 Set/Get the pickable instance variable. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable. 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 ()
 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 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(). More...
 
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(). More...
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys. 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...
 
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)
 Add or remove or get or check a consumer,. More...
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,. More...
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property. More...
 
- 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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Protected Member Functions

 vtkBiDimensionalRepresentation ()
 
 ~vtkBiDimensionalRepresentation () 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)
 
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 ()
 These methods allow a command to exclusively grab all events. More...
 
- 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

int Modifier
 
vtkHandleRepresentationHandleRepresentation
 
vtkHandleRepresentationPoint1Representation
 
vtkHandleRepresentationPoint2Representation
 
vtkHandleRepresentationPoint3Representation
 
vtkHandleRepresentationPoint4Representation
 
int Tolerance
 
vtkTypeBool Line1Visibility
 
vtkTypeBool Line2Visibility
 
vtkIdType ID
 
int IDInitialized
 
double P1World [3]
 
double P2World [3]
 
double P3World [3]
 
double P4World [3]
 
double P21World [3]
 
double P43World [3]
 
double T21
 
double T43
 
double CenterWorld [3]
 
double StartEventPositionWorld [4]
 
char * LabelFormat
 
vtkTypeBool ShowLabelAboveWidget
 
- 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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkWidgetRepresentation Superclass
 Standard VTK methods. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard VTK methods. More...
 
static vtkBiDimensionalRepresentationSafeDownCast (vtkObjectBase *o)
 Standard VTK methods. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard VTK methods. More...
 
vtkBiDimensionalRepresentationNewInstance () const
 Standard VTK methods. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard VTK methods. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard VTK methods. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class. More...
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
- 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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...
 

Detailed Description

represent the vtkBiDimensionalWidget

The vtkBiDimensionalRepresentation is used to represent the bi-dimensional measure of an object. This representation consists of two perpendicular lines defined by four vtkHandleRepresentations. The four handles can be independently manipulated consistent with the orthogonal constraint on the lines. (Note: the four points are referred to as Point1, Point2, Point3 and Point4. Point1 and Point2 define the first line; and Point3 and Point4 define the second orthogonal line.) This particular class is an abstract class, contrete subclasses (e.g., vtkBiDimensionalRepresentation2D) actual implement the widget.

To create this widget, you click to place the first two points. The third point is mirrored with the fourth point; when you place the third point (which is orthogonal to the lined defined by the first two points), the fourth point is dropped as well. After definition, the four points can be moved (in constrained fashion, preserving orthogonality). Further, the entire widget can be translated by grabbing the center point of the widget; each line can be moved along the other line; and the entire widget can be rotated around its center point.

See also
vtkAngleWidget vtkHandleRepresentation vtkBiDimensionalRepresentation2D

Definition at line 52 of file vtkBiDimensionalRepresentation.h.

Member Typedef Documentation

Standard VTK methods.

Definition at line 59 of file vtkBiDimensionalRepresentation.h.

Member Enumeration Documentation

anonymous enum
Enumerator
Outside 
NearP1 
NearP2 
NearP3 
NearP4 
OnL1Inner 
OnL1Outer 
OnL2Inner 
OnL2Outer 
OnCenter 

Definition at line 164 of file vtkBiDimensionalRepresentation.h.

Constructor & Destructor Documentation

vtkBiDimensionalRepresentation::vtkBiDimensionalRepresentation ( )
protected
vtkBiDimensionalRepresentation::~vtkBiDimensionalRepresentation ( )
overrideprotected

Member Function Documentation

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

Standard VTK methods.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkBiDimensionalRepresentation2D.

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

Standard VTK methods.

virtual vtkObjectBase* vtkBiDimensionalRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkBiDimensionalRepresentation2D.

vtkBiDimensionalRepresentation* vtkBiDimensionalRepresentation::NewInstance ( ) const

Standard VTK methods.

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

Standard VTK methods.

Reimplemented from vtkObject.

Reimplemented in vtkBiDimensionalRepresentation2D.

virtual void vtkBiDimensionalRepresentation::SetPoint1WorldPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::SetPoint2WorldPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::SetPoint3WorldPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::SetPoint4WorldPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::GetPoint1WorldPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::GetPoint2WorldPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::GetPoint3WorldPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::GetPoint4WorldPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::SetPoint1DisplayPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::SetPoint2DisplayPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::SetPoint3DisplayPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::SetPoint4DisplayPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::GetPoint1DisplayPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::GetPoint2DisplayPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::GetPoint3DisplayPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual void vtkBiDimensionalRepresentation::GetPoint4DisplayPosition ( double  pos[3])
virtual

Methods to Set/Get the coordinates of the four points defining this representation.

Note that methods are available for both display and world coordinates.

virtual vtkHandleRepresentation* vtkBiDimensionalRepresentation::GetPoint1Representation ( )
virtual

Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D.

(Note: properties can be set by grabbing these representations and setting the properties appropriately.)

virtual vtkHandleRepresentation* vtkBiDimensionalRepresentation::GetPoint2Representation ( )
virtual

Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D.

(Note: properties can be set by grabbing these representations and setting the properties appropriately.)

virtual vtkHandleRepresentation* vtkBiDimensionalRepresentation::GetPoint3Representation ( )
virtual

Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D.

(Note: properties can be set by grabbing these representations and setting the properties appropriately.)

virtual vtkHandleRepresentation* vtkBiDimensionalRepresentation::GetPoint4Representation ( )
virtual

Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D.

(Note: properties can be set by grabbing these representations and setting the properties appropriately.)

virtual void vtkBiDimensionalRepresentation::SetLine1Visibility ( vtkTypeBool  )
virtual

Special methods for turning off the lines that define the bi-dimensional measure.

Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.

virtual vtkTypeBool vtkBiDimensionalRepresentation::GetLine1Visibility ( )
virtual

Special methods for turning off the lines that define the bi-dimensional measure.

Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.

virtual void vtkBiDimensionalRepresentation::Line1VisibilityOn ( )
virtual

Special methods for turning off the lines that define the bi-dimensional measure.

Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.

virtual void vtkBiDimensionalRepresentation::Line1VisibilityOff ( )
virtual

Special methods for turning off the lines that define the bi-dimensional measure.

Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.

virtual void vtkBiDimensionalRepresentation::SetLine2Visibility ( vtkTypeBool  )
virtual

Special methods for turning off the lines that define the bi-dimensional measure.

Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.

virtual vtkTypeBool vtkBiDimensionalRepresentation::GetLine2Visibility ( )
virtual

Special methods for turning off the lines that define the bi-dimensional measure.

Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.

virtual void vtkBiDimensionalRepresentation::Line2VisibilityOn ( )
virtual

Special methods for turning off the lines that define the bi-dimensional measure.

Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.

virtual void vtkBiDimensionalRepresentation::Line2VisibilityOff ( )
virtual

Special methods for turning off the lines that define the bi-dimensional measure.

Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.

void vtkBiDimensionalRepresentation::SetHandleRepresentation ( vtkHandleRepresentation handle)

This method is used to specify the type of handle representation to use for the four internal vtkHandleRepresentations within vtkBiDimensionalRepresentation.

To use this method, create a dummy vtkHandleRepresentation (or subclass), and then invoke this method with this dummy. Then the vtkBiDimensionalRepresentation uses this dummy to clone four vtkHandleRepresentations of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkBiDimensionalWidget for the purposes of cloning.)

virtual void vtkBiDimensionalRepresentation::InstantiateHandleRepresentation ( )
virtual

This method is used to specify the type of handle representation to use for the four internal vtkHandleRepresentations within vtkBiDimensionalRepresentation.

To use this method, create a dummy vtkHandleRepresentation (or subclass), and then invoke this method with this dummy. Then the vtkBiDimensionalRepresentation uses this dummy to clone four vtkHandleRepresentations of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkBiDimensionalWidget for the purposes of cloning.)

virtual void vtkBiDimensionalRepresentation::SetTolerance ( int  )
virtual

The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the representation to be active.

virtual int vtkBiDimensionalRepresentation::GetTolerance ( )
virtual

The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the representation to be active.

virtual double vtkBiDimensionalRepresentation::GetLength1 ( )
virtual

Return the length of the line defined by (Point1,Point2).

This is the distance in the world coordinate system.

virtual double vtkBiDimensionalRepresentation::GetLength2 ( )
virtual

Return the length of the line defined by (Point3,Point4).

This is the distance in the world coordinate system.

virtual void vtkBiDimensionalRepresentation::SetLabelFormat ( const char *  )
virtual

Specify the format to use for labelling the distance.

Note that an empty string results in no label, or a format string without a "%" character will not print the distance value.

virtual char* vtkBiDimensionalRepresentation::GetLabelFormat ( )
virtual

Specify the format to use for labelling the distance.

Note that an empty string results in no label, or a format string without a "%" character will not print the distance value.

virtual void vtkBiDimensionalRepresentation::SetShowLabelAboveWidget ( vtkTypeBool  )
virtual

Toggle whether to display the label above or below the widget.

Defaults to 1.

virtual vtkTypeBool vtkBiDimensionalRepresentation::GetShowLabelAboveWidget ( )
virtual

Toggle whether to display the label above or below the widget.

Defaults to 1.

virtual void vtkBiDimensionalRepresentation::ShowLabelAboveWidgetOn ( )
virtual

Toggle whether to display the label above or below the widget.

Defaults to 1.

virtual void vtkBiDimensionalRepresentation::ShowLabelAboveWidgetOff ( )
virtual

Toggle whether to display the label above or below the widget.

Defaults to 1.

void vtkBiDimensionalRepresentation::SetID ( vtkIdType  id)

Set/get the id to display in the label.

virtual vtkIdType vtkBiDimensionalRepresentation::GetID ( )
virtual

Set/get the id to display in the label.

virtual char* vtkBiDimensionalRepresentation::GetLabelText ( )
pure virtual

Get the text shown in the widget's label.

Implemented in vtkBiDimensionalRepresentation2D.

virtual double* vtkBiDimensionalRepresentation::GetLabelPosition ( )
pure virtual

Get the position of the widget's label in display coordinates.

Implemented in vtkBiDimensionalRepresentation2D.

virtual void vtkBiDimensionalRepresentation::GetLabelPosition ( double  pos[3])
pure virtual

Get the position of the widget's label in display coordinates.

Implemented in vtkBiDimensionalRepresentation2D.

virtual void vtkBiDimensionalRepresentation::GetWorldLabelPosition ( double  pos[3])
pure virtual

Get the position of the widget's label in display coordinates.

Implemented in vtkBiDimensionalRepresentation2D.

virtual void vtkBiDimensionalRepresentation::StartWidgetDefinition ( double  e[2])
pure virtual

These are methods that satisfy vtkWidgetRepresentation's API.

Implemented in vtkBiDimensionalRepresentation2D.

virtual void vtkBiDimensionalRepresentation::Point2WidgetInteraction ( double  e[2])
pure virtual

These are methods that satisfy vtkWidgetRepresentation's API.

Implemented in vtkBiDimensionalRepresentation2D.

virtual void vtkBiDimensionalRepresentation::Point3WidgetInteraction ( double  e[2])
pure virtual

These are methods that satisfy vtkWidgetRepresentation's API.

Implemented in vtkBiDimensionalRepresentation2D.

virtual void vtkBiDimensionalRepresentation::StartWidgetManipulation ( double  e[2])
pure virtual

These are methods that satisfy vtkWidgetRepresentation's API.

Implemented in vtkBiDimensionalRepresentation2D.

Member Data Documentation

int vtkBiDimensionalRepresentation::Modifier
protected

Definition at line 213 of file vtkBiDimensionalRepresentation.h.

vtkHandleRepresentation* vtkBiDimensionalRepresentation::HandleRepresentation
protected

Definition at line 216 of file vtkBiDimensionalRepresentation.h.

vtkHandleRepresentation* vtkBiDimensionalRepresentation::Point1Representation
protected

Definition at line 217 of file vtkBiDimensionalRepresentation.h.

vtkHandleRepresentation* vtkBiDimensionalRepresentation::Point2Representation
protected

Definition at line 218 of file vtkBiDimensionalRepresentation.h.

vtkHandleRepresentation* vtkBiDimensionalRepresentation::Point3Representation
protected

Definition at line 219 of file vtkBiDimensionalRepresentation.h.

vtkHandleRepresentation* vtkBiDimensionalRepresentation::Point4Representation
protected

Definition at line 220 of file vtkBiDimensionalRepresentation.h.

int vtkBiDimensionalRepresentation::Tolerance
protected

Definition at line 223 of file vtkBiDimensionalRepresentation.h.

vtkTypeBool vtkBiDimensionalRepresentation::Line1Visibility
protected

Definition at line 226 of file vtkBiDimensionalRepresentation.h.

vtkTypeBool vtkBiDimensionalRepresentation::Line2Visibility
protected

Definition at line 227 of file vtkBiDimensionalRepresentation.h.

vtkIdType vtkBiDimensionalRepresentation::ID
protected

Definition at line 229 of file vtkBiDimensionalRepresentation.h.

int vtkBiDimensionalRepresentation::IDInitialized
protected

Definition at line 230 of file vtkBiDimensionalRepresentation.h.

double vtkBiDimensionalRepresentation::P1World[3]
protected

Definition at line 233 of file vtkBiDimensionalRepresentation.h.

double vtkBiDimensionalRepresentation::P2World[3]
protected

Definition at line 234 of file vtkBiDimensionalRepresentation.h.

double vtkBiDimensionalRepresentation::P3World[3]
protected

Definition at line 235 of file vtkBiDimensionalRepresentation.h.

double vtkBiDimensionalRepresentation::P4World[3]
protected

Definition at line 236 of file vtkBiDimensionalRepresentation.h.

double vtkBiDimensionalRepresentation::P21World[3]
protected

Definition at line 237 of file vtkBiDimensionalRepresentation.h.

double vtkBiDimensionalRepresentation::P43World[3]
protected

Definition at line 238 of file vtkBiDimensionalRepresentation.h.

double vtkBiDimensionalRepresentation::T21
protected

Definition at line 239 of file vtkBiDimensionalRepresentation.h.

double vtkBiDimensionalRepresentation::T43
protected

Definition at line 240 of file vtkBiDimensionalRepresentation.h.

double vtkBiDimensionalRepresentation::CenterWorld[3]
protected

Definition at line 241 of file vtkBiDimensionalRepresentation.h.

double vtkBiDimensionalRepresentation::StartEventPositionWorld[4]
protected

Definition at line 242 of file vtkBiDimensionalRepresentation.h.

char* vtkBiDimensionalRepresentation::LabelFormat
protected

Definition at line 245 of file vtkBiDimensionalRepresentation.h.

vtkTypeBool vtkBiDimensionalRepresentation::ShowLabelAboveWidget
protected

Definition at line 248 of file vtkBiDimensionalRepresentation.h.


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