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

provide a compass More...

#include <vtkCompassRepresentation.h>

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

Public Types

enum  _InteractionState {
  Outside =0, Inside, Adjusting, TiltDown,
  TiltUp, TiltAdjusting, DistanceOut, DistanceIn,
  DistanceAdjusting
}
 
- Public Types inherited from vtkContinuousValueWidgetRepresentation
enum  _InteractionState { Outside =0, Inside, Adjusting }
 
typedef vtkWidgetRepresentation Superclass
 
- Public Types inherited from vtkWidgetRepresentation
typedef vtkProp Superclass
 

Public Member Functions

vtkCoordinateGetPoint1Coordinate ()
 
vtkCoordinateGetPoint2Coordinate ()
 
virtual void SetHeading (double value)
 
virtual double GetHeading ()
 
virtual void SetTilt (double value)
 
virtual double GetTilt ()
 
virtual void UpdateTilt (double time)
 
virtual void EndTilt ()
 
virtual void SetDistance (double value)
 
virtual double GetDistance ()
 
virtual void UpdateDistance (double time)
 
virtual void EndDistance ()
 
virtual void SetRenderer (vtkRenderer *ren)
 
virtual vtkProperty2DGetRingProperty ()
 
virtual vtkProperty2DGetSelectedProperty ()
 
virtual vtkTextPropertyGetLabelProperty ()
 
virtual void PlaceWidget (double bounds[6])
 
virtual void BuildRepresentation ()
 
virtual void StartWidgetInteraction (double eventPos[2])
 
virtual void WidgetInteraction (double eventPos[2])
 
virtual void TiltWidgetInteraction (double eventPos[2])
 
virtual void DistanceWidgetInteraction (double eventPos[2])
 
virtual int ComputeInteractionState (int X, int Y, int modify=0)
 
virtual void Highlight (int)
 
virtual void GetActors (vtkPropCollection *)
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 
virtual int RenderOverlay (vtkViewport *)
 
virtual int RenderOpaqueGeometry (vtkViewport *)
 
- Public Member Functions inherited from vtkContinuousValueWidgetRepresentation
virtual void SetValue (double value)
 
virtual double GetValue ()
 
void PrintSelf (ostream &os, vtkIndent indent)
 
- Public Member Functions inherited from vtkWidgetRepresentation
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 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 ()
 
void PrintSelf (ostream &os, vtkIndent indent)
 
- 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 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 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 ()
 

Static Public Member Functions

static vtkCompassRepresentationNew ()
 
- Static Public Member Functions inherited from vtkContinuousValueWidgetRepresentation
static int IsTypeOf (const char *type)
 
static
vtkContinuousValueWidgetRepresentation
SafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkCompassRepresentation ()
 
 ~vtkCompassRepresentation ()
 
void BuildRing ()
 
void BuildBackdrop ()
 
void GetCenterAndUnitRadius (int center[2], double &radius)
 
- Protected Member Functions inherited from vtkContinuousValueWidgetRepresentation
 vtkContinuousValueWidgetRepresentation ()
 
 ~vtkContinuousValueWidgetRepresentation ()
 
- 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

vtkCoordinatePoint1Coordinate
 
vtkCoordinatePoint2Coordinate
 
double InnerRadius
 
double OuterRadius
 
vtkSmartPointer
< vtkCenteredSliderRepresentation
TiltRepresentation
 
vtkSmartPointer
< vtkCenteredSliderRepresentation
DistanceRepresentation
 
vtkTransformXForm
 
vtkPointsPoints
 
vtkPolyDataRing
 
vtkTransformPolyDataFilterRingXForm
 
vtkPolyDataMapper2DRingMapper
 
vtkActor2DRingActor
 
vtkProperty2DRingProperty
 
vtkPolyDataMapper2DBackdropMapper
 
vtkActor2DBackdrop
 
vtkTextPropertyLabelProperty
 
vtkTextActorLabelActor
 
vtkTextPropertyStatusProperty
 
vtkTextActorStatusActor
 
vtkProperty2DSelectedProperty
 
int HighlightState
 
double Heading
 
double Tilt
 
double Distance
 
- Protected Attributes inherited from vtkContinuousValueWidgetRepresentation
double Value
 
- 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
vtkContinuousValueWidgetRepresentation 
Superclass
 
static int IsTypeOf (const char *type)
 
static vtkCompassRepresentationSafeDownCast (vtkObject *o)
 
virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Detailed Description

provide a compass

This class is used to represent and render a compass.

Definition at line 52 of file vtkCompassRepresentation.h.

Member Typedef Documentation

Standard methods for the class.

Definition at line 62 of file vtkCompassRepresentation.h.

Member Enumeration Documentation

Enumerator:
Outside 
Inside 
Adjusting 
TiltDown 
TiltUp 
TiltAdjusting 
DistanceOut 
DistanceIn 
DistanceAdjusting 

Definition at line 135 of file vtkCompassRepresentation.h.

Constructor & Destructor Documentation

vtkCompassRepresentation::vtkCompassRepresentation ( )
protected
vtkCompassRepresentation::~vtkCompassRepresentation ( )
protected

Member Function Documentation

static vtkCompassRepresentation* vtkCompassRepresentation::New ( )
static

Instantiate the class.

virtual const char* vtkCompassRepresentation::GetClassName ( )
virtual

Standard methods for the class.

Reimplemented from vtkContinuousValueWidgetRepresentation.

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

Standard methods for the class.

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

Standard methods for the class.

Reimplemented from vtkContinuousValueWidgetRepresentation.

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

Standard methods for the class.

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

Standard methods for the class.

Reimplemented from vtkProp.

vtkCoordinate* vtkCompassRepresentation::GetPoint1Coordinate ( )

Position the first end point of the slider. Note that this point is an instance of vtkCoordinate, meaning that Point 1 can be specified in a variety of coordinate systems, and can even be relative to another point. To set the point, you'll want to get the Point1Coordinate and then invoke the necessary methods to put it into the correct coordinate system and set the correct initial value.

vtkCoordinate* vtkCompassRepresentation::GetPoint2Coordinate ( )

Position the second end point of the slider. Note that this point is an instance of vtkCoordinate, meaning that Point 1 can be specified in a variety of coordinate systems, and can even be relative to another point. To set the point, you'll want to get the Point2Coordinate and then invoke the necessary methods to put it into the correct coordinate system and set the correct initial value.

virtual vtkProperty2D* vtkCompassRepresentation::GetRingProperty ( )
virtual

Get the slider properties. The properties of the slider when selected and unselected can be manipulated.

virtual vtkProperty2D* vtkCompassRepresentation::GetSelectedProperty ( )
virtual

Get the selection property. This property is used to modify the appearance of selected objects (e.g., the slider).

virtual vtkTextProperty* vtkCompassRepresentation::GetLabelProperty ( )
virtual

Set/Get the properties for the label and title text.

virtual void vtkCompassRepresentation::PlaceWidget ( double  bounds[6])
virtual

Methods to interface with the vtkSliderWidget. The PlaceWidget() method assumes that the parameter bounds[6] specifies the location in display space where the widget should be placed.

Reimplemented from vtkContinuousValueWidgetRepresentation.

virtual void vtkCompassRepresentation::BuildRepresentation ( )
virtual

Methods to interface with the vtkSliderWidget. The PlaceWidget() method assumes that the parameter bounds[6] specifies the location in display space where the widget should be placed.

Reimplemented from vtkContinuousValueWidgetRepresentation.

virtual void vtkCompassRepresentation::StartWidgetInteraction ( double  eventPos[2])
virtual

Methods to interface with the vtkSliderWidget. The PlaceWidget() method assumes that the parameter bounds[6] specifies the location in display space where the widget should be placed.

Implements vtkContinuousValueWidgetRepresentation.

virtual void vtkCompassRepresentation::WidgetInteraction ( double  eventPos[2])
virtual

Methods to interface with the vtkSliderWidget. The PlaceWidget() method assumes that the parameter bounds[6] specifies the location in display space where the widget should be placed.

Implements vtkContinuousValueWidgetRepresentation.

virtual void vtkCompassRepresentation::TiltWidgetInteraction ( double  eventPos[2])
virtual

Methods to interface with the vtkSliderWidget. The PlaceWidget() method assumes that the parameter bounds[6] specifies the location in display space where the widget should be placed.

virtual void vtkCompassRepresentation::DistanceWidgetInteraction ( double  eventPos[2])
virtual

Methods to interface with the vtkSliderWidget. The PlaceWidget() method assumes that the parameter bounds[6] specifies the location in display space where the widget should be placed.

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

Methods to interface with the vtkSliderWidget. The PlaceWidget() method assumes that the parameter bounds[6] specifies the location in display space where the widget should be placed.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkCompassRepresentation::Highlight ( int  )
virtual

Methods to interface with the vtkSliderWidget. The PlaceWidget() method assumes that the parameter bounds[6] specifies the location in display space where the widget should be placed.

virtual void vtkCompassRepresentation::GetActors ( vtkPropCollection )
virtual

Methods supporting the rendering process.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkCompassRepresentation::ReleaseGraphicsResources ( vtkWindow )
virtual

Methods supporting the rendering process.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkCompassRepresentation::RenderOverlay ( vtkViewport )
virtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

virtual int vtkCompassRepresentation::RenderOpaqueGeometry ( vtkViewport )
virtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

virtual void vtkCompassRepresentation::SetHeading ( double  value)
virtual
virtual double vtkCompassRepresentation::GetHeading ( )
virtual
virtual void vtkCompassRepresentation::SetTilt ( double  value)
virtual
virtual double vtkCompassRepresentation::GetTilt ( )
virtual
virtual void vtkCompassRepresentation::UpdateTilt ( double  time)
virtual
virtual void vtkCompassRepresentation::EndTilt ( )
virtual
virtual void vtkCompassRepresentation::SetDistance ( double  value)
virtual
virtual double vtkCompassRepresentation::GetDistance ( )
virtual
virtual void vtkCompassRepresentation::UpdateDistance ( double  time)
virtual
virtual void vtkCompassRepresentation::EndDistance ( )
virtual
virtual void vtkCompassRepresentation::SetRenderer ( vtkRenderer ren)
virtual

Subclasses of vtkWidgetRepresentation must implement these methods. This is considered the minimum API for a widget representation.

     SetRenderer() - the renderer in which the widget is to appear must be
     set. BuildRepresentation() - update the geometry of the widget based
     on its current state. 

WARNING: The renderer is NOT reference counted by the representation, in order to avoid reference loops. Be sure that the representation lifetime does not extend beyond the renderer lifetime.

Reimplemented from vtkWidgetRepresentation.

void vtkCompassRepresentation::BuildRing ( )
protected
void vtkCompassRepresentation::BuildBackdrop ( )
protected
void vtkCompassRepresentation::GetCenterAndUnitRadius ( int  center[2],
double &  radius 
)
protected

Member Data Documentation

vtkCoordinate* vtkCompassRepresentation::Point1Coordinate
protected

Definition at line 154 of file vtkCompassRepresentation.h.

vtkCoordinate* vtkCompassRepresentation::Point2Coordinate
protected

Definition at line 155 of file vtkCompassRepresentation.h.

double vtkCompassRepresentation::InnerRadius
protected

Definition at line 158 of file vtkCompassRepresentation.h.

double vtkCompassRepresentation::OuterRadius
protected

Definition at line 159 of file vtkCompassRepresentation.h.

vtkSmartPointer<vtkCenteredSliderRepresentation> vtkCompassRepresentation::TiltRepresentation
protected

Definition at line 163 of file vtkCompassRepresentation.h.

vtkSmartPointer<vtkCenteredSliderRepresentation> vtkCompassRepresentation::DistanceRepresentation
protected

Definition at line 164 of file vtkCompassRepresentation.h.

vtkTransform* vtkCompassRepresentation::XForm
protected

Definition at line 169 of file vtkCompassRepresentation.h.

vtkPoints* vtkCompassRepresentation::Points
protected

Definition at line 170 of file vtkCompassRepresentation.h.

vtkPolyData* vtkCompassRepresentation::Ring
protected

Definition at line 172 of file vtkCompassRepresentation.h.

vtkTransformPolyDataFilter* vtkCompassRepresentation::RingXForm
protected

Definition at line 173 of file vtkCompassRepresentation.h.

vtkPolyDataMapper2D* vtkCompassRepresentation::RingMapper
protected

Definition at line 174 of file vtkCompassRepresentation.h.

vtkActor2D* vtkCompassRepresentation::RingActor
protected

Definition at line 175 of file vtkCompassRepresentation.h.

vtkProperty2D* vtkCompassRepresentation::RingProperty
protected

Definition at line 176 of file vtkCompassRepresentation.h.

vtkPolyDataMapper2D* vtkCompassRepresentation::BackdropMapper
protected

Definition at line 178 of file vtkCompassRepresentation.h.

vtkActor2D* vtkCompassRepresentation::Backdrop
protected

Definition at line 179 of file vtkCompassRepresentation.h.

vtkTextProperty* vtkCompassRepresentation::LabelProperty
protected

Definition at line 181 of file vtkCompassRepresentation.h.

vtkTextActor* vtkCompassRepresentation::LabelActor
protected

Definition at line 182 of file vtkCompassRepresentation.h.

vtkTextProperty* vtkCompassRepresentation::StatusProperty
protected

Definition at line 183 of file vtkCompassRepresentation.h.

vtkTextActor* vtkCompassRepresentation::StatusActor
protected

Definition at line 184 of file vtkCompassRepresentation.h.

vtkProperty2D* vtkCompassRepresentation::SelectedProperty
protected

Definition at line 186 of file vtkCompassRepresentation.h.

int vtkCompassRepresentation::HighlightState
protected

Definition at line 195 of file vtkCompassRepresentation.h.

double vtkCompassRepresentation::Heading
protected

Definition at line 197 of file vtkCompassRepresentation.h.

double vtkCompassRepresentation::Tilt
protected

Definition at line 198 of file vtkCompassRepresentation.h.

double vtkCompassRepresentation::Distance
protected

Definition at line 199 of file vtkCompassRepresentation.h.


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