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

represent the vtkDistanceWidget More...

#include <vtkDistanceRepresentation2D.h>

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

Public Types

typedef vtkDistanceRepresentation Superclass
 Standard VTK methods. More...
 
- Public Types inherited from vtkDistanceRepresentation
enum  { Outside = 0, NearP1, NearP2 }
 
typedef vtkWidgetRepresentation Superclass
 Standard VTK methods. 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...
 
vtkDistanceRepresentation2DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
double GetDistance () override
 Satisfy the superclasses API. More...
 
double * GetPoint1WorldPosition () override
 Methods to Set/Get the coordinates of the two points defining this representation. More...
 
double * GetPoint2WorldPosition () override
 
void GetPoint1WorldPosition (double pos[3]) override
 Methods to Set/Get the coordinates of the two points defining this representation. More...
 
void GetPoint2WorldPosition (double pos[3]) override
 
void SetPoint1WorldPosition (double pos[3]) override
 
void SetPoint2WorldPosition (double pos[3]) override
 
void SetPoint1DisplayPosition (double pos[3]) override
 
void SetPoint2DisplayPosition (double pos[3]) override
 
void GetPoint1DisplayPosition (double pos[3]) override
 
void GetPoint2DisplayPosition (double pos[3]) override
 
vtkAxisActor2DGetAxis ()
 Retrieve the vtkAxisActor2D used to draw the measurement axis. More...
 
vtkProperty2DGetAxisProperty ()
 
void BuildRepresentation () override
 Method to satisfy superclasses' API. More...
 
void ReleaseGraphicsResources (vtkWindow *w) override
 Methods required by vtkProp superclass. 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...
 
- Public Member Functions inherited from vtkDistanceRepresentation
vtkDistanceRepresentationNewInstance () const
 
void SetHandleRepresentation (vtkHandleRepresentation *handle)
 This method is used to specify the type of handle representation to use for the two internal vtkHandleWidgets within vtkDistanceWidget. More...
 
void InstantiateHandleRepresentation ()
 
virtual vtkHandleRepresentationGetPoint1Representation ()
 Set/Get the two handle representations used for the vtkDistanceWidget. More...
 
virtual vtkHandleRepresentationGetPoint2Representation ()
 
virtual void SetTolerance (int)
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the end points of the widget to be active. More...
 
virtual int GetTolerance ()
 
virtual void SetLabelFormat (const char *)
 Specify the format to use for labelling the distance. More...
 
virtual char * GetLabelFormat ()
 
virtual void SetScale (double)
 Set the scale factor from VTK world coordinates. More...
 
virtual double GetScale ()
 
virtual void SetRulerMode (vtkTypeBool)
 Enable or disable ruler mode. More...
 
virtual vtkTypeBool GetRulerMode ()
 
virtual void RulerModeOn ()
 
virtual void RulerModeOff ()
 
virtual void SetRulerDistance (double)
 Specify the RulerDistance which indicates the spacing of the major ticks. More...
 
virtual double GetRulerDistance ()
 
virtual void SetNumberOfRulerTicks (int)
 Specify the number of major ruler ticks. More...
 
virtual int GetNumberOfRulerTicks ()
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 
void StartWidgetInteraction (double e[2]) override
 
void WidgetInteraction (double e[2]) override
 
void StartComplexInteraction (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) override
 
void ComplexInteraction (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) override
 
int ComputeComplexInteractionState (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata, int modify=0) override
 
- 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 void SetRenderer (vtkRenderer *ren)
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
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 EndComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
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 RenderTranslucentPolygonalGeometry (vtkViewport *)
 
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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

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

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDistanceRepresentation2D ()
 
 ~vtkDistanceRepresentation2D () override
 
- Protected Member Functions inherited from vtkDistanceRepresentation
 vtkDistanceRepresentation ()
 
 ~vtkDistanceRepresentation () override
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation () override
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the widget representation currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path. More...
 
vtkAssemblyPathGetAssemblyPath3DPoint (double pos[3], vtkAbstractPropPicker *picker)
 
bool NearbyEvent (int X, int Y, double bounds[6])
 
double SizeHandlesRelativeToViewport (double factor, double pos[3])
 
double SizeHandlesInPixels (double factor, double pos[3])
 
void UpdatePropPose (vtkProp3D *prop, const double *pos1, const double *orient1, const double *pos2, const double *orient2)
 
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 
 ~vtkProp () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkAxisActor2DAxisActor
 
vtkProperty2DAxisProperty
 
double Distance
 
- Protected Attributes inherited from vtkDistanceRepresentation
vtkHandleRepresentationHandleRepresentation
 
vtkHandleRepresentationPoint1Representation
 
vtkHandleRepresentationPoint2Representation
 
int Tolerance
 
char * LabelFormat
 
double Scale
 
vtkTypeBool RulerMode
 
double RulerDistance
 
int NumberOfRulerTicks
 
- Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRendererRenderer
 
int InteractionState
 
double StartEventPosition [3]
 
double PlaceFactor
 
int Placed
 
double InitialBounds [6]
 
double InitialLength
 
int ValidPick
 
bool PickingManaged
 
double HandleSize
 
vtkTypeBool NeedToRender
 
vtkTimeStamp BuildTime
 
vtkNew< vtkTransformTempTransform
 
vtkNew< vtkMatrix4x4TempMatrix
 
- Protected Attributes inherited from vtkProp
vtkTypeBool Visibility
 
vtkTypeBool Pickable
 
vtkTypeBool Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

represent the vtkDistanceWidget

The vtkDistanceRepresentation2D is a representation for the vtkDistanceWidget. This representation consists of a measuring line (axis) and two vtkHandleWidgets to place the end points of the line. Note that this particular widget draws its representation in the overlay plane, and the handles also operate in the 2D overlay plane. (If you desire to use the distance widget for 3D measurements, use the vtkDistanceRepresentation3D.)

See also
vtkDistanceWidget vtkDistanceRepresentation vtkDistanceRepresentation3D

Definition at line 40 of file vtkDistanceRepresentation2D.h.

Member Typedef Documentation

◆ Superclass

Standard VTK methods.

Definition at line 52 of file vtkDistanceRepresentation2D.h.

Constructor & Destructor Documentation

◆ vtkDistanceRepresentation2D()

vtkDistanceRepresentation2D::vtkDistanceRepresentation2D ( )
protected

◆ ~vtkDistanceRepresentation2D()

vtkDistanceRepresentation2D::~vtkDistanceRepresentation2D ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkDistanceRepresentation2D* vtkDistanceRepresentation2D::New ( )
static

Instantiate class.

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDistanceRepresentation2D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDistanceRepresentation.

◆ NewInstance()

vtkDistanceRepresentation2D* vtkDistanceRepresentation2D::NewInstance ( ) const

◆ PrintSelf()

void vtkDistanceRepresentation2D::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 vtkDistanceRepresentation.

◆ GetDistance()

double vtkDistanceRepresentation2D::GetDistance ( )
inlineoverridevirtual

Satisfy the superclasses API.

Implements vtkDistanceRepresentation.

Definition at line 59 of file vtkDistanceRepresentation2D.h.

◆ GetPoint1WorldPosition() [1/2]

double* vtkDistanceRepresentation2D::GetPoint1WorldPosition ( )
overridevirtual

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

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

Implements vtkDistanceRepresentation.

◆ GetPoint2WorldPosition() [1/2]

double* vtkDistanceRepresentation2D::GetPoint2WorldPosition ( )
overridevirtual

◆ GetPoint1WorldPosition() [2/2]

void vtkDistanceRepresentation2D::GetPoint1WorldPosition ( double  pos[3])
overridevirtual

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

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

Implements vtkDistanceRepresentation.

◆ GetPoint2WorldPosition() [2/2]

void vtkDistanceRepresentation2D::GetPoint2WorldPosition ( double  pos[3])
overridevirtual

◆ SetPoint1WorldPosition()

void vtkDistanceRepresentation2D::SetPoint1WorldPosition ( double  pos[3])
overridevirtual

◆ SetPoint2WorldPosition()

void vtkDistanceRepresentation2D::SetPoint2WorldPosition ( double  pos[3])
overridevirtual

◆ SetPoint1DisplayPosition()

void vtkDistanceRepresentation2D::SetPoint1DisplayPosition ( double  pos[3])
overridevirtual

◆ SetPoint2DisplayPosition()

void vtkDistanceRepresentation2D::SetPoint2DisplayPosition ( double  pos[3])
overridevirtual

◆ GetPoint1DisplayPosition()

void vtkDistanceRepresentation2D::GetPoint1DisplayPosition ( double  pos[3])
overridevirtual

◆ GetPoint2DisplayPosition()

void vtkDistanceRepresentation2D::GetPoint2DisplayPosition ( double  pos[3])
overridevirtual

◆ GetAxis()

vtkAxisActor2D* vtkDistanceRepresentation2D::GetAxis ( )

Retrieve the vtkAxisActor2D used to draw the measurement axis.

With this properties can be set and so on. There is also a convenience method to get the axis property.

◆ GetAxisProperty()

vtkProperty2D* vtkDistanceRepresentation2D::GetAxisProperty ( )

◆ BuildRepresentation()

void vtkDistanceRepresentation2D::BuildRepresentation ( )
overridevirtual

Method to satisfy superclasses' API.

Reimplemented from vtkDistanceRepresentation.

◆ ReleaseGraphicsResources()

void vtkDistanceRepresentation2D::ReleaseGraphicsResources ( vtkWindow w)
overridevirtual

Methods required by vtkProp superclass.

Reimplemented from vtkProp.

◆ RenderOverlay()

int vtkDistanceRepresentation2D::RenderOverlay ( vtkViewport viewport)
overridevirtual

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkDistanceRepresentation2D::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.

Member Data Documentation

◆ AxisActor

vtkAxisActor2D* vtkDistanceRepresentation2D::AxisActor
protected

Definition at line 109 of file vtkDistanceRepresentation2D.h.

◆ AxisProperty

vtkProperty2D* vtkDistanceRepresentation2D::AxisProperty
protected

Definition at line 110 of file vtkDistanceRepresentation2D.h.

◆ Distance

double vtkDistanceRepresentation2D::Distance
protected

Definition at line 113 of file vtkDistanceRepresentation2D.h.


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