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

represent the vtkAngleWidget More...

#include <vtkAngleRepresentation.h>

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

Public Types

enum  { Outside = 0, NearP1, NearCenter, NearP2 }
- Public Types inherited from vtkWidgetRepresentation
typedef vtkProp Superclass

Public Member Functions

virtual double GetAngle ()=0
virtual void GetPoint1WorldPosition (double pos[3])=0
virtual void GetCenterWorldPosition (double pos[3])=0
virtual void GetPoint2WorldPosition (double pos[3])=0
virtual void SetPoint1DisplayPosition (double pos[3])=0
virtual void SetCenterDisplayPosition (double pos[3])=0
virtual void SetPoint2DisplayPosition (double pos[3])=0
virtual void GetPoint1DisplayPosition (double pos[3])=0
virtual void GetCenterDisplayPosition (double pos[3])=0
virtual void GetPoint2DisplayPosition (double pos[3])=0
void SetHandleRepresentation (vtkHandleRepresentation *handle)
void InstantiateHandleRepresentation ()
virtual vtkHandleRepresentationGetPoint1Representation ()
virtual vtkHandleRepresentationGetCenterRepresentation ()
virtual vtkHandleRepresentationGetPoint2Representation ()
virtual void SetTolerance (int)
virtual int GetTolerance ()
virtual void SetLabelFormat (const char *)
virtual char * GetLabelFormat ()
virtual void SetRay1Visibility (int)
virtual int GetRay1Visibility ()
virtual void Ray1VisibilityOn ()
virtual void Ray1VisibilityOff ()
virtual void SetRay2Visibility (int)
virtual int GetRay2Visibility ()
virtual void Ray2VisibilityOn ()
virtual void Ray2VisibilityOff ()
virtual void SetArcVisibility (int)
virtual int GetArcVisibility ()
virtual void ArcVisibilityOn ()
virtual void ArcVisibilityOff ()
virtual void BuildRepresentation ()
virtual int ComputeInteractionState (int X, int Y, int modify=0)
virtual void StartWidgetInteraction (double e[2])
virtual void CenterWidgetInteraction (double e[2])
virtual void WidgetInteraction (double e[2])
- Public Member Functions inherited from vtkWidgetRepresentation
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 double * GetBounds ()
virtual void ShallowCopy (vtkProp *prop)
virtual void GetActors (vtkPropCollection *)
virtual void GetActors2D (vtkPropCollection *)
virtual void GetVolumes (vtkPropCollection *)
virtual void ReleaseGraphicsResources (vtkWindow *)
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
virtual void Pick ()
virtual unsigned long GetRedrawMTime ()
virtual bool HasKeys (vtkInformation *requiredKeys)
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
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 SetDragable (int)
virtual int GetDragable ()
virtual void DragableOn ()
virtual void DragableOff ()
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 int RenderOpaqueGeometry (vtkViewport *)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int RenderVolumetricGeometry (vtkViewport *)
virtual int RenderOverlay (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 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
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
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 Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Protected Member Functions

 vtkAngleRepresentation ()
 ~vtkAngleRepresentation ()
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 ~vtkWidgetRepresentation ()
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkHandleRepresentationHandleRepresentation
vtkHandleRepresentationPoint1Representation
vtkHandleRepresentationCenterRepresentation
vtkHandleRepresentationPoint2Representation
int Tolerance
int Ray1Visibility
int Ray2Visibility
int ArcVisibility
char * LabelFormat
- Protected Attributes inherited from vtkWidgetRepresentation
vtkRendererRenderer
int InteractionState
double StartEventPosition [3]
double PlaceFactor
int Placed
double InitialBounds [6]
double InitialLength
int ValidPick
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
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers
typedef vtkWidgetRepresentation Superclass
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
static int IsTypeOf (const char *type)
static vtkAngleRepresentationSafeDownCast (vtkObject *o)

Additional Inherited Members

- Static Public Member Functions inherited from vtkWidgetRepresentation
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()
- Friends inherited from vtkObject

Detailed Description

represent the vtkAngleWidget

The vtkAngleRepresentation is a superclass for classes representing the vtkAngleWidget. This representation consists of two rays and three vtkHandleRepresentations to place and manipulate the three points defining the angle representation. (Note: the three points are referred to as Point1, Center, and Point2, at the two end points (Point1 and Point2) and Center (around which the angle is measured).

See Also
vtkAngleWidget vtkHandleRepresentation vtkAngleRepresentation2D

Definition at line 37 of file vtkAngleRepresentation.h.

Member Typedef Documentation

Standard VTK methods.

Definition at line 42 of file vtkAngleRepresentation.h.

Member Enumeration Documentation

anonymous enum
Enumerator:
Outside 
NearP1 
NearCenter 
NearP2 

Definition at line 118 of file vtkAngleRepresentation.h.

Constructor & Destructor Documentation

vtkAngleRepresentation::vtkAngleRepresentation ( )
protected
vtkAngleRepresentation::~vtkAngleRepresentation ( )
protected

Member Function Documentation

virtual const char* vtkAngleRepresentation::GetClassName ( )
virtual

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

virtual int vtkAngleRepresentation::IsA ( const char *  type)
virtual

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

static vtkAngleRepresentation* vtkAngleRepresentation::SafeDownCast ( vtkObject o)
static

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

void vtkAngleRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

virtual double vtkAngleRepresentation::GetAngle ( )
pure virtual

This representation and all subclasses must keep an angle (in degrees) consistent with the state of the widget.

Implemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

virtual void vtkAngleRepresentation::GetPoint1WorldPosition ( double  pos[3])
pure virtual

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

virtual void vtkAngleRepresentation::GetCenterWorldPosition ( double  pos[3])
pure virtual

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

virtual void vtkAngleRepresentation::GetPoint2WorldPosition ( double  pos[3])
pure virtual

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

virtual void vtkAngleRepresentation::SetPoint1DisplayPosition ( double  pos[3])
pure virtual

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

virtual void vtkAngleRepresentation::SetCenterDisplayPosition ( double  pos[3])
pure virtual

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

virtual void vtkAngleRepresentation::SetPoint2DisplayPosition ( double  pos[3])
pure virtual

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

virtual void vtkAngleRepresentation::GetPoint1DisplayPosition ( double  pos[3])
pure virtual

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

virtual void vtkAngleRepresentation::GetCenterDisplayPosition ( double  pos[3])
pure virtual

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

virtual void vtkAngleRepresentation::GetPoint2DisplayPosition ( double  pos[3])
pure virtual

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

void vtkAngleRepresentation::SetHandleRepresentation ( vtkHandleRepresentation handle)

This method is used to specify the type of handle representation to use for the three internal vtkHandleWidgets within vtkAngleRepresentation. To use this method, create a dummy vtkHandleRepresentation (or subclass), and then invoke this method with this dummy. Then the vtkAngleRepresentation uses this dummy to clone three vtkHandleRepresentations of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkAngle widget.)

void vtkAngleRepresentation::InstantiateHandleRepresentation ( )

This method is used to specify the type of handle representation to use for the three internal vtkHandleWidgets within vtkAngleRepresentation. To use this method, create a dummy vtkHandleRepresentation (or subclass), and then invoke this method with this dummy. Then the vtkAngleRepresentation uses this dummy to clone three vtkHandleRepresentations of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkAngle widget.)

virtual vtkHandleRepresentation* vtkAngleRepresentation::GetPoint1Representation ( )
virtual

Set/Get the handle representations used for the vtkAngleRepresentation.

virtual vtkHandleRepresentation* vtkAngleRepresentation::GetCenterRepresentation ( )
virtual

Set/Get the handle representations used for the vtkAngleRepresentation.

virtual vtkHandleRepresentation* vtkAngleRepresentation::GetPoint2Representation ( )
virtual

Set/Get the handle representations used for the vtkAngleRepresentation.

virtual void vtkAngleRepresentation::SetTolerance ( int  )
virtual

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

virtual int vtkAngleRepresentation::GetTolerance ( )
virtual

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

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

Specify the format to use for labelling the angle. Note that an empty string results in no label, or a format string without a "%" character will not print the angle value.

virtual char* vtkAngleRepresentation::GetLabelFormat ( )
virtual

Specify the format to use for labelling the angle. Note that an empty string results in no label, or a format string without a "%" character will not print the angle value.

virtual void vtkAngleRepresentation::SetRay1Visibility ( int  )
virtual

Special methods for turning off the rays and arc that define the cone and arc of the angle.

virtual int vtkAngleRepresentation::GetRay1Visibility ( )
virtual

Special methods for turning off the rays and arc that define the cone and arc of the angle.

virtual void vtkAngleRepresentation::Ray1VisibilityOn ( )
virtual

Special methods for turning off the rays and arc that define the cone and arc of the angle.

virtual void vtkAngleRepresentation::Ray1VisibilityOff ( )
virtual

Special methods for turning off the rays and arc that define the cone and arc of the angle.

virtual void vtkAngleRepresentation::SetRay2Visibility ( int  )
virtual

Special methods for turning off the rays and arc that define the cone and arc of the angle.

virtual int vtkAngleRepresentation::GetRay2Visibility ( )
virtual

Special methods for turning off the rays and arc that define the cone and arc of the angle.

virtual void vtkAngleRepresentation::Ray2VisibilityOn ( )
virtual

Special methods for turning off the rays and arc that define the cone and arc of the angle.

virtual void vtkAngleRepresentation::Ray2VisibilityOff ( )
virtual

Special methods for turning off the rays and arc that define the cone and arc of the angle.

virtual void vtkAngleRepresentation::SetArcVisibility ( int  )
virtual

Special methods for turning off the rays and arc that define the cone and arc of the angle.

virtual int vtkAngleRepresentation::GetArcVisibility ( )
virtual

Special methods for turning off the rays and arc that define the cone and arc of the angle.

virtual void vtkAngleRepresentation::ArcVisibilityOn ( )
virtual

Special methods for turning off the rays and arc that define the cone and arc of the angle.

virtual void vtkAngleRepresentation::ArcVisibilityOff ( )
virtual

Special methods for turning off the rays and arc that define the cone and arc of the angle.

virtual void vtkAngleRepresentation::BuildRepresentation ( )
virtual

These are methods that satisfy vtkWidgetRepresentation's API.

Implements vtkWidgetRepresentation.

Reimplemented in vtkAngleRepresentation3D, and vtkAngleRepresentation2D.

virtual int vtkAngleRepresentation::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
)
virtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkAngleRepresentation::StartWidgetInteraction ( double  e[2])
virtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkAngleRepresentation::CenterWidgetInteraction ( double  e[2])
virtual

These are methods that satisfy vtkWidgetRepresentation's API.

virtual void vtkAngleRepresentation::WidgetInteraction ( double  e[2])
virtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

Member Data Documentation

vtkHandleRepresentation* vtkAngleRepresentation::HandleRepresentation
protected

Definition at line 135 of file vtkAngleRepresentation.h.

vtkHandleRepresentation* vtkAngleRepresentation::Point1Representation
protected

Definition at line 136 of file vtkAngleRepresentation.h.

vtkHandleRepresentation* vtkAngleRepresentation::CenterRepresentation
protected

Definition at line 137 of file vtkAngleRepresentation.h.

vtkHandleRepresentation* vtkAngleRepresentation::Point2Representation
protected

Definition at line 138 of file vtkAngleRepresentation.h.

int vtkAngleRepresentation::Tolerance
protected

Definition at line 141 of file vtkAngleRepresentation.h.

int vtkAngleRepresentation::Ray1Visibility
protected

Definition at line 144 of file vtkAngleRepresentation.h.

int vtkAngleRepresentation::Ray2Visibility
protected

Definition at line 145 of file vtkAngleRepresentation.h.

int vtkAngleRepresentation::ArcVisibility
protected

Definition at line 146 of file vtkAngleRepresentation.h.

char* vtkAngleRepresentation::LabelFormat
protected

Definition at line 149 of file vtkAngleRepresentation.h.


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