vtkCompassRepresentation Class Reference

#include <vtkCompassRepresentation.h>

Inheritance diagram for vtkCompassRepresentation:

Inheritance graph
[legend]
Collaboration diagram for vtkCompassRepresentation:

Collaboration graph
[legend]

List of all members.


Detailed Description

provide a compass

This class is used to represent and render a compass.

Definition at line 52 of file vtkCompassRepresentation.h.

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)

Public Types

enum  _InteractionState {
  Outside = 0, Inside, Adjusting, TiltDown,
  TiltUp, TiltAdjusting, DistanceOut, DistanceIn,
  DistanceAdjusting
}

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

Static Public Member Functions

static vtkCompassRepresentationNew ()

Protected Member Functions

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

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

Member Typedef Documentation

Standard methods for the class.

Reimplemented from vtkContinuousValueWidgetRepresentation.

Definition at line 62 of file vtkCompassRepresentation.h.


Member Enumeration Documentation

Enumerator:
Outside 
Inside 
Adjusting 
TiltDown 
TiltUp 
TiltAdjusting 
DistanceOut 
DistanceIn 
DistanceAdjusting 

Reimplemented from vtkContinuousValueWidgetRepresentation.

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.

Reimplemented from vtkObject.

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.

Reimplemented from vtkContinuousValueWidgetRepresentation.

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.

Reimplemented from vtkContinuousValueWidgetRepresentation.

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

Standard methods for the class.

Reimplemented from vtkContinuousValueWidgetRepresentation.

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

Definition at line 154 of file vtkCompassRepresentation.h.

Definition at line 155 of file vtkCompassRepresentation.h.

Definition at line 158 of file vtkCompassRepresentation.h.

Definition at line 159 of file vtkCompassRepresentation.h.

Definition at line 163 of file vtkCompassRepresentation.h.

Definition at line 164 of file vtkCompassRepresentation.h.

Definition at line 169 of file vtkCompassRepresentation.h.

Definition at line 170 of file vtkCompassRepresentation.h.

Definition at line 172 of file vtkCompassRepresentation.h.

Definition at line 173 of file vtkCompassRepresentation.h.

Definition at line 174 of file vtkCompassRepresentation.h.

Definition at line 175 of file vtkCompassRepresentation.h.

Definition at line 176 of file vtkCompassRepresentation.h.

Definition at line 178 of file vtkCompassRepresentation.h.

Definition at line 179 of file vtkCompassRepresentation.h.

Definition at line 181 of file vtkCompassRepresentation.h.

Definition at line 182 of file vtkCompassRepresentation.h.

Definition at line 183 of file vtkCompassRepresentation.h.

Definition at line 184 of file vtkCompassRepresentation.h.

Definition at line 186 of file vtkCompassRepresentation.h.

Definition at line 195 of file vtkCompassRepresentation.h.

Definition at line 197 of file vtkCompassRepresentation.h.

double vtkCompassRepresentation::Tilt [protected]

Definition at line 198 of file vtkCompassRepresentation.h.

Definition at line 199 of file vtkCompassRepresentation.h.


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

Generated on Mon Sep 27 18:20:18 2010 for VTK by  doxygen 1.5.6