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
 
- Public Types inherited from vtkDistanceRepresentation
enum  { Outside =0, NearP1, NearP2 }
 
typedef vtkWidgetRepresentation Superclass
 
- Public Types inherited from vtkWidgetRepresentation
typedef vtkProp Superclass
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkDistanceRepresentation2DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual double GetDistance ()
 
doubleGetPoint1WorldPosition ()
 
doubleGetPoint2WorldPosition ()
 
void GetPoint1WorldPosition (double pos[3])
 
void GetPoint2WorldPosition (double pos[3])
 
void SetPoint1WorldPosition (double pos[3])
 
void SetPoint2WorldPosition (double pos[3])
 
void SetPoint1DisplayPosition (double pos[3])
 
void SetPoint2DisplayPosition (double pos[3])
 
void GetPoint1DisplayPosition (double pos[3])
 
void GetPoint2DisplayPosition (double pos[3])
 
vtkAxisActor2DGetAxis ()
 
vtkProperty2DGetAxisProperty ()
 
virtual void BuildRepresentation ()
 
virtual void ReleaseGraphicsResources (vtkWindow *w)
 
virtual int RenderOverlay (vtkViewport *viewport)
 
virtual int RenderOpaqueGeometry (vtkViewport *viewport)
 
- Public Member Functions inherited from vtkDistanceRepresentation
vtkDistanceRepresentationNewInstance () const
 
void SetHandleRepresentation (vtkHandleRepresentation *handle)
 
void InstantiateHandleRepresentation ()
 
virtual vtkHandleRepresentationGetPoint1Representation ()
 
virtual vtkHandleRepresentationGetPoint2Representation ()
 
virtual void SetTolerance (int)
 
virtual int GetTolerance ()
 
virtual void SetLabelFormat (const char *)
 
virtual char * GetLabelFormat ()
 
virtual void SetRulerMode (int)
 
virtual int GetRulerMode ()
 
virtual void RulerModeOn ()
 
virtual void RulerModeOff ()
 
virtual void SetRulerDistance (double)
 
virtual double GetRulerDistance ()
 
virtual void SetNumberOfRulerTicks (int)
 
virtual int GetNumberOfRulerTicks ()
 
virtual int ComputeInteractionState (int X, int Y, int modify=0)
 
virtual void StartWidgetInteraction (double e[2])
 
virtual void WidgetInteraction (double e[2])
 
- Public Member Functions inherited from vtkWidgetRepresentation
vtkWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void PickingManagedOn ()
 
virtual void PickingManagedOff ()
 
virtual void SetPickingManaged (bool)
 
virtual bool GetPickingManaged ()
 
virtual void SetRenderer (vtkRenderer *ren)
 
virtual vtkRendererGetRenderer ()
 
virtual void PlaceWidget (double *vtkNotUsed(bounds[6]))
 
virtual void EndWidgetInteraction (double newEventPos[2])
 
virtual int GetInteractionState ()
 
virtual void Highlight (int vtkNotUsed(highlightOn))
 
virtual void SetPlaceFactor (double)
 
virtual double GetPlaceFactor ()
 
virtual void SetHandleSize (double)
 
virtual double GetHandleSize ()
 
virtual int GetNeedToRender ()
 
virtual void SetNeedToRender (int)
 
virtual void NeedToRenderOn ()
 
virtual void NeedToRenderOff ()
 
virtual doubleGetBounds ()
 
virtual void ShallowCopy (vtkProp *prop)
 
virtual void GetActors (vtkPropCollection *)
 
virtual void GetActors2D (vtkPropCollection *)
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual int RenderOverlay (vtkViewport *vtkNotUsed(viewport))
 
virtual int RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport))
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport))
 
virtual int RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport))
 
virtual int HasTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetVisibility (int)
 
virtual int GetVisibility ()
 
virtual void VisibilityOn ()
 
virtual void VisibilityOff ()
 
virtual void SetPickable (int)
 
virtual int GetPickable ()
 
virtual void PickableOn ()
 
virtual void PickableOff ()
 
virtual void Pick ()
 
virtual void SetDragable (int)
 
virtual int GetDragable ()
 
virtual void DragableOn ()
 
virtual void DragableOff ()
 
virtual unsigned long GetRedrawMTime ()
 
virtual void SetUseBounds (bool)
 
virtual bool GetUseBounds ()
 
virtual void UseBoundsOn ()
 
virtual void UseBoundsOff ()
 
virtual void InitPathTraversal ()
 
virtual vtkAssemblyPathGetNextPath ()
 
virtual int GetNumberOfPaths ()
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual vtkInformationGetPropertyKeys ()
 
virtual void SetPropertyKeys (vtkInformation *keys)
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 
virtual void RestoreEstimatedRenderTime ()
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
 
virtual double GetAllocatedRenderTime ()
 
void SetRenderTimeMultiplier (double t)
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 
virtual bool GetSupportsSelection ()
 
virtual int GetNumberOfConsumers ()
 
void AddConsumer (vtkObject *c)
 
void RemoveConsumer (vtkObject *c)
 
vtkObjectGetConsumer (int i)
 
int IsConsumer (vtkObject *c)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
int GetReferenceCount ()
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkDistanceRepresentation2DNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDistanceRepresentation2DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDistanceRepresentation
static int IsTypeOf (const char *type)
 
static vtkDistanceRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static int IsTypeOf (const char *type)
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp
static int IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDistanceRepresentation2D ()
 
 ~vtkDistanceRepresentation2D ()
 
- Protected Member Functions inherited from vtkDistanceRepresentation
 vtkDistanceRepresentation ()
 
 ~vtkDistanceRepresentation ()
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation ()
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
virtual void RegisterPickers ()
 
virtual void UnRegisterPickers ()
 
virtual void PickersModified ()
 
vtkPickingManagerGetPickingManager ()
 
vtkAssemblyPathGetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 
double SizeHandlesRelativeToViewport (double factor, double pos[3])
 
double SizeHandlesInPixels (double factor, double pos[3])
 
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 
 ~vtkProp ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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
 
int 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
 
int NeedToRender
 
vtkTimeStamp BuildTime
 
- Protected Attributes inherited from vtkProp
int Visibility
 
int Pickable
 
int Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 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
Examples:
vtkDistanceRepresentation2D (Examples)
Tests:
vtkDistanceRepresentation2D (Tests)

Definition at line 46 of file vtkDistanceRepresentation2D.h.

Member Typedef Documentation

◆ Superclass

Standard VTK methods.

Definition at line 54 of file vtkDistanceRepresentation2D.h.

Constructor & Destructor Documentation

◆ vtkDistanceRepresentation2D()

vtkDistanceRepresentation2D::vtkDistanceRepresentation2D ( )
protected

◆ ~vtkDistanceRepresentation2D()

vtkDistanceRepresentation2D::~vtkDistanceRepresentation2D ( )
protected

Member Function Documentation

◆ New()

static vtkDistanceRepresentation2D* vtkDistanceRepresentation2D::New ( )
static

Instantiate class.

◆ IsTypeOf()

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

◆ IsA()

virtual int 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 
)
virtual

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()

virtual double vtkDistanceRepresentation2D::GetDistance ( )
inlinevirtual

Satisfy the superclasses API.

Implements vtkDistanceRepresentation.

Definition at line 60 of file vtkDistanceRepresentation2D.h.

◆ GetPoint1WorldPosition() [1/2]

double* vtkDistanceRepresentation2D::GetPoint1WorldPosition ( )
virtual

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 ( )
virtual

◆ GetPoint1WorldPosition() [2/2]

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

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])
virtual

◆ SetPoint1WorldPosition()

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

◆ SetPoint2WorldPosition()

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

◆ SetPoint1DisplayPosition()

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

◆ SetPoint2DisplayPosition()

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

◆ GetPoint1DisplayPosition()

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

◆ GetPoint2DisplayPosition()

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

◆ 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()

virtual void vtkDistanceRepresentation2D::BuildRepresentation ( )
virtual

Method to satisfy superclasses' API.

Reimplemented from vtkDistanceRepresentation.

◆ ReleaseGraphicsResources()

virtual void vtkDistanceRepresentation2D::ReleaseGraphicsResources ( vtkWindow w)
virtual

Methods required by vtkProp superclass.

Reimplemented from vtkWidgetRepresentation.

◆ RenderOverlay()

virtual int vtkDistanceRepresentation2D::RenderOverlay ( vtkViewport viewport)
virtual

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

virtual int vtkDistanceRepresentation2D::RenderOpaqueGeometry ( vtkViewport )
virtual

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 104 of file vtkDistanceRepresentation2D.h.

◆ AxisProperty

vtkProperty2D* vtkDistanceRepresentation2D::AxisProperty
protected

Definition at line 105 of file vtkDistanceRepresentation2D.h.

◆ Distance

double vtkDistanceRepresentation2D::Distance
protected

Definition at line 108 of file vtkDistanceRepresentation2D.h.


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