provide a compass More...

#include <vtkCompassRepresentation.h>

Inheritance diagram for vtkCompassRepresentation:

Collaboration diagram for vtkCompassRepresentation:

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 Types inherited from vtkProp
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	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 ()

vtkContinuousValueWidgetRepresentation *	NewInstance () 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 ()

vtkWidgetRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Pick ()

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 unsigned long	GetRedrawMTime ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual void	InitPathTraversal ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkMatrix4x4 *	GetMatrix ()

virtual vtkInformation *	GetPropertyKeys ()

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)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () 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)

vtkCommand *	GetCommand (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	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkCompassRepresentation *	New ()

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

Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

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

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 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
vtkCoordinate *	Point1Coordinate

vtkCoordinate *	Point2Coordinate

double	InnerRadius

double	OuterRadius

vtkSmartPointer< vtkCenteredSliderRepresentation >	TiltRepresentation

vtkSmartPointer< vtkCenteredSliderRepresentation >	DistanceRepresentation

vtkTransform *	XForm

vtkPoints *	Points

vtkPolyData *	Ring

vtkTransformPolyDataFilter *	RingXForm

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

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

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkContinuousValueWidgetRepresentation	Superclass

static int	IsTypeOf (const char *type)

static vtkCompassRepresentation *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkCompassRepresentation *	NewInstance () 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

typedef vtkContinuousValueWidgetRepresentation vtkCompassRepresentation::Superclass

Standard methods for the class.

Definition at line 63 of file vtkCompassRepresentation.h.

Member Enumeration Documentation

enum vtkCompassRepresentation::_InteractionState

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
	)

virtual

Standard methods for the class.

Reimplemented from vtkObject.

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