VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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

vtkCoordinate * GetPoint1Coordinate ()
 
vtkCoordinate * GetPoint2Coordinate ()
 
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 vtkProperty2D * GetRingProperty ()
 
virtual vtkProperty2D * GetSelectedProperty ()
 
virtual vtkTextProperty * GetLabelProperty ()
 
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 ()
 
vtkContinuousValueWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
- Public Member Functions inherited from vtkWidgetRepresentation
virtual void PickingManagedOn ()
 
virtual void PickingManagedOff ()
 
virtual void SetPickingManaged (bool)
 
virtual bool GetPickingManaged ()
 
virtual vtkRenderer * GetRenderer ()
 
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 ()
 
vtkWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkCompassRepresentationNew ()
 
- Static Public Member Functions inherited from vtkContinuousValueWidgetRepresentation
static int IsTypeOf (const char *type)
 
static
vtkContinuousValueWidgetRepresentation
SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static int IsTypeOf (const char *type)
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *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])
 
virtual void RegisterPickers ()
 
virtual void UnRegisterPickers ()
 
virtual void PickersModified ()
 
vtkPickingManager * GetPickingManager ()
 
double SizeHandlesRelativeToViewport (double factor, double pos[3])
 
double SizeHandlesInPixels (double factor, double pos[3])
 
vtkAssemblyPath * GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 

Protected Attributes

vtkCoordinate * Point1Coordinate
 
vtkCoordinate * Point2Coordinate
 
double InnerRadius
 
double OuterRadius
 
vtkSmartPointer
< vtkCenteredSliderRepresentation
TiltRepresentation
 
vtkSmartPointer
< vtkCenteredSliderRepresentation
DistanceRepresentation
 
vtkTransformXForm
 
vtkPoints * Points
 
vtkPolyDataRing
 
vtkTransformPolyDataFilterRingXForm
 
vtkPolyDataMapper2D * RingMapper
 
vtkActor2D * RingActor
 
vtkProperty2D * RingProperty
 
vtkPolyDataMapper2D * BackdropMapper
 
vtkActor2D * Backdrop
 
vtkTextProperty * LabelProperty
 
vtkTextActor * LabelActor
 
vtkTextProperty * StatusProperty
 
vtkTextActor * StatusActor
 
vtkProperty2D * SelectedProperty
 
int HighlightState
 
double Heading
 
double Tilt
 
double Distance
 
- Protected Attributes inherited from vtkContinuousValueWidgetRepresentation
double Value
 
- Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRenderer > Renderer
 
int InteractionState
 
double StartEventPosition [3]
 
double PlaceFactor
 
int Placed
 
double InitialBounds [6]
 
double InitialLength
 
int ValidPick
 
bool PickingManaged
 
double HandleSize
 
int NeedToRender
 
vtkTimeStamp BuildTime
 
typedef
vtkContinuousValueWidgetRepresentation 
Superclass
 
static int IsTypeOf (const char *type)
 
static vtkCompassRepresentationSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkCompassRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 

Detailed Description

provide a compass

This class is used to represent and render a compass.

Definition at line 53 of file vtkCompassRepresentation.h.

Member Typedef Documentation

Standard methods for the class.

Definition at line 63 of file vtkCompassRepresentation.h.

Member Enumeration Documentation

Enumerator
Outside 
Inside 
Adjusting 
TiltDown 
TiltUp 
TiltAdjusting 
DistanceOut 
DistanceIn 
DistanceAdjusting 

Definition at line 136 of file vtkCompassRepresentation.h.

Constructor & Destructor Documentation

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

Member Function Documentation

static vtkCompassRepresentation* vtkCompassRepresentation::New ( )
static

Instantiate the class.

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 ( vtkObjectBase *  o)
static

Standard methods for the class.

virtual vtkObjectBase* vtkCompassRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for the class.

Reimplemented from vtkContinuousValueWidgetRepresentation.

vtkCompassRepresentation* vtkCompassRepresentation::NewInstance ( ) const

Standard methods for the class.

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

Standard methods for the class.

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.

virtual int vtkCompassRepresentation::RenderOpaqueGeometry ( vtkViewport *  )
virtual

Methods supporting the rendering process.

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 155 of file vtkCompassRepresentation.h.

vtkCoordinate* vtkCompassRepresentation::Point2Coordinate
protected

Definition at line 156 of file vtkCompassRepresentation.h.

double vtkCompassRepresentation::InnerRadius
protected

Definition at line 159 of file vtkCompassRepresentation.h.

double vtkCompassRepresentation::OuterRadius
protected

Definition at line 160 of file vtkCompassRepresentation.h.

vtkSmartPointer<vtkCenteredSliderRepresentation> vtkCompassRepresentation::TiltRepresentation
protected

Definition at line 164 of file vtkCompassRepresentation.h.

vtkSmartPointer<vtkCenteredSliderRepresentation> vtkCompassRepresentation::DistanceRepresentation
protected

Definition at line 165 of file vtkCompassRepresentation.h.

vtkTransform* vtkCompassRepresentation::XForm
protected

Definition at line 170 of file vtkCompassRepresentation.h.

vtkPoints* vtkCompassRepresentation::Points
protected

Definition at line 171 of file vtkCompassRepresentation.h.

vtkPolyData* vtkCompassRepresentation::Ring
protected

Definition at line 173 of file vtkCompassRepresentation.h.

vtkTransformPolyDataFilter* vtkCompassRepresentation::RingXForm
protected

Definition at line 174 of file vtkCompassRepresentation.h.

vtkPolyDataMapper2D* vtkCompassRepresentation::RingMapper
protected

Definition at line 175 of file vtkCompassRepresentation.h.

vtkActor2D* vtkCompassRepresentation::RingActor
protected

Definition at line 176 of file vtkCompassRepresentation.h.

vtkProperty2D* vtkCompassRepresentation::RingProperty
protected

Definition at line 177 of file vtkCompassRepresentation.h.

vtkPolyDataMapper2D* vtkCompassRepresentation::BackdropMapper
protected

Definition at line 179 of file vtkCompassRepresentation.h.

vtkActor2D* vtkCompassRepresentation::Backdrop
protected

Definition at line 180 of file vtkCompassRepresentation.h.

vtkTextProperty* vtkCompassRepresentation::LabelProperty
protected

Definition at line 182 of file vtkCompassRepresentation.h.

vtkTextActor* vtkCompassRepresentation::LabelActor
protected

Definition at line 183 of file vtkCompassRepresentation.h.

vtkTextProperty* vtkCompassRepresentation::StatusProperty
protected

Definition at line 184 of file vtkCompassRepresentation.h.

vtkTextActor* vtkCompassRepresentation::StatusActor
protected

Definition at line 185 of file vtkCompassRepresentation.h.

vtkProperty2D* vtkCompassRepresentation::SelectedProperty
protected

Definition at line 187 of file vtkCompassRepresentation.h.

int vtkCompassRepresentation::HighlightState
protected

Definition at line 196 of file vtkCompassRepresentation.h.

double vtkCompassRepresentation::Heading
protected

Definition at line 198 of file vtkCompassRepresentation.h.

double vtkCompassRepresentation::Tilt
protected

Definition at line 199 of file vtkCompassRepresentation.h.

double vtkCompassRepresentation::Distance
protected

Definition at line 200 of file vtkCompassRepresentation.h.


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