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
}
 
typedef vtkContinuousValueWidgetRepresentation Superclass
 Standard methods for the class. More...
 
- Public Types inherited from vtkContinuousValueWidgetRepresentation
enum  _InteractionState { Outside = 0, Inside, Adjusting }
 
typedef vtkWidgetRepresentation Superclass
 Standard methods for the class. More...
 
- Public Types inherited from vtkWidgetRepresentation
enum  Axis { NONE = -1, XAxis = 0, YAxis = 1, ZAxis = 2 }
 Axis labels. More...
 
typedef vtkProp Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCompassRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkCoordinateGetPoint1Coordinate ()
 Position the first end point of the slider. More...
 
vtkCoordinateGetPoint2Coordinate ()
 Position the second end point of the slider. More...
 
virtual vtkProperty2DGetRingProperty ()
 Get the slider properties. More...
 
virtual vtkProperty2DGetSelectedProperty ()
 Get the selection property. More...
 
virtual vtkTextPropertyGetLabelProperty ()
 Set/Get the properties for the label and title text. More...
 
void PlaceWidget (double bounds[6]) override
 Methods to interface with the vtkSliderWidget. More...
 
void BuildRepresentation () override
 
void StartWidgetInteraction (double eventPos[2]) override
 
void WidgetInteraction (double eventPos[2]) override
 
virtual void TiltWidgetInteraction (double eventPos[2])
 
virtual void DistanceWidgetInteraction (double eventPos[2])
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 
void Highlight (int) override
 
void GetActors (vtkPropCollection *) override
 Methods supporting the rendering process. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...
 
int RenderOverlay (vtkViewport *) override
 
int RenderOpaqueGeometry (vtkViewport *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. More...
 
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 ()
 
void SetRenderer (vtkRenderer *ren) override
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
- Public Member Functions inherited from vtkContinuousValueWidgetRepresentation
vtkContinuousValueWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void PlaceWidget (double bounds[6]) override
 Methods to interface with the vtkSliderWidget. More...
 
void BuildRepresentation () override
 
virtual void SetValue (double value)
 
virtual double GetValue ()
 
- Public Member Functions inherited from vtkWidgetRepresentation
vtkWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 
void SetPickingManaged (bool managed)
 
virtual bool GetPickingManaged ()
 
virtual vtkRendererGetRenderer ()
 
virtual void PlaceWidget (double *vtkNotUsed(bounds[6]))
 The following is a suggested API for widget representations. More...
 
virtual void EndWidgetInteraction (double newEventPos[2])
 
virtual int GetInteractionState ()
 
virtual void Highlight (int vtkNotUsed(highlightOn))
 
virtual void StartComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual void ComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual void EndComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual int ComputeComplexInteractionState (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *callData, int modify=0)
 
virtual void SetPlaceFactor (double)
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
virtual double GetPlaceFactor ()
 
virtual void SetHandleSize (double)
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...
 
virtual double GetHandleSize ()
 
virtual vtkTypeBool GetNeedToRender ()
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...
 
virtual void SetNeedToRender (vtkTypeBool)
 
virtual void NeedToRenderOn ()
 
virtual void NeedToRenderOff ()
 
double * GetBounds () override
 Methods to make this class behave as a vtkProp. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp. More...
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
void GetActors2D (vtkPropCollection *) override
 
void GetVolumes (vtkPropCollection *) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...
 
int RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More...
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
virtual void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 
virtual void VisibilityOn ()
 
virtual void VisibilityOff ()
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 
virtual void PickableOn ()
 
virtual void PickableOff ()
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 
virtual void DragableOn ()
 
virtual void DragableOff ()
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
virtual void SetUseBounds (bool)
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual bool GetUseBounds ()
 
virtual void UseBoundsOn ()
 
virtual void UseBoundsOff ()
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkAssemblyPathGetNextPath ()
 
virtual int GetNumberOfPaths ()
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
virtual vtkTypeBool HasOpaqueGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry. More...
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...
 
virtual void RestoreEstimatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
void SetRenderTimeMultiplier (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...
 
virtual bool GetSupportsSelection ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 
vtkObjectGetConsumer (int i)
 
int IsConsumer (vtkObject *c)
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkCompassRepresentationNew ()
 Instantiate the class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCompassRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkContinuousValueWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContinuousValueWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCompassRepresentation ()
 
 ~vtkCompassRepresentation () override
 
void BuildRing ()
 
void BuildBackdrop ()
 
void GetCenterAndUnitRadius (int center[2], double &radius)
 
- Protected Member Functions inherited from vtkContinuousValueWidgetRepresentation
 vtkContinuousValueWidgetRepresentation ()
 
 ~vtkContinuousValueWidgetRepresentation () override
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation () override
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the widget representation currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path. More...
 
vtkAssemblyPathGetAssemblyPath3DPoint (double pos[3], vtkAbstractPropPicker *picker)
 
bool NearbyEvent (int X, int Y, double bounds[6])
 
double SizeHandlesRelativeToViewport (double factor, double pos[3])
 
double SizeHandlesInPixels (double factor, double pos[3])
 
void UpdatePropPose (vtkProp3D *prop, const double *pos1, const double *orient1, const double *pos2, const double *orient2)
 
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 
 ~vtkProp () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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

vtkCoordinatePoint1Coordinate
 
vtkCoordinatePoint2Coordinate
 
double InnerRadius
 
double OuterRadius
 
vtkSmartPointer< vtkCenteredSliderRepresentationTiltRepresentation
 
vtkSmartPointer< vtkCenteredSliderRepresentationDistanceRepresentation
 
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
vtkWeakPointer< vtkRendererRenderer
 
int InteractionState
 
double StartEventPosition [3]
 
double PlaceFactor
 
int Placed
 
double InitialBounds [6]
 
double InitialLength
 
int ValidPick
 
bool PickingManaged
 
double HandleSize
 
vtkTypeBool NeedToRender
 
vtkTimeStamp BuildTime
 
vtkNew< vtkTransformTempTransform
 
vtkNew< vtkMatrix4x4TempMatrix
 
- Protected Attributes inherited from vtkProp
vtkTypeBool Visibility
 
vtkTypeBool Pickable
 
vtkTypeBool Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

◆ Superclass

Standard methods for the class.

Definition at line 65 of file vtkCompassRepresentation.h.

Member Enumeration Documentation

◆ _InteractionState

Enumerator
Outside 
Inside 
Adjusting 
TiltDown 
TiltUp 
TiltAdjusting 
DistanceOut 
DistanceIn 
DistanceAdjusting 

Definition at line 151 of file vtkCompassRepresentation.h.

Constructor & Destructor Documentation

◆ vtkCompassRepresentation()

vtkCompassRepresentation::vtkCompassRepresentation ( )
protected

◆ ~vtkCompassRepresentation()

vtkCompassRepresentation::~vtkCompassRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkCompassRepresentation* vtkCompassRepresentation::New ( )
static

Instantiate the class.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCompassRepresentation::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkContinuousValueWidgetRepresentation.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCompassRepresentation::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkCompassRepresentation* vtkCompassRepresentation::NewInstance ( ) const

◆ PrintSelf()

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

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ GetPoint1Coordinate()

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.

◆ GetPoint2Coordinate()

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.

◆ GetRingProperty()

virtual vtkProperty2D* vtkCompassRepresentation::GetRingProperty ( )
virtual

Get the slider properties.

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

◆ GetSelectedProperty()

virtual vtkProperty2D* vtkCompassRepresentation::GetSelectedProperty ( )
virtual

Get the selection property.

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

◆ GetLabelProperty()

virtual vtkTextProperty* vtkCompassRepresentation::GetLabelProperty ( )
virtual

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

◆ PlaceWidget()

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

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.

◆ BuildRepresentation()

void vtkCompassRepresentation::BuildRepresentation ( )
overridevirtual

◆ StartWidgetInteraction()

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

◆ WidgetInteraction()

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

◆ TiltWidgetInteraction()

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

◆ DistanceWidgetInteraction()

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

◆ ComputeInteractionState()

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

Reimplemented from vtkWidgetRepresentation.

◆ Highlight()

void vtkCompassRepresentation::Highlight ( int  )
override

◆ GetActors()

void vtkCompassRepresentation::GetActors ( vtkPropCollection )
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkCompassRepresentation::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

◆ RenderOverlay()

int vtkCompassRepresentation::RenderOverlay ( vtkViewport )
overridevirtual

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkCompassRepresentation::RenderOpaqueGeometry ( vtkViewport )
overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.

There are four key render methods in vtk and they correspond to four different points in the rendering cycle. Any given prop may implement one or more of these methods. The first method is intended for rendering all opaque geometry. The second method is intended for rendering all translucent polygonal geometry. The third one is intended for rendering all translucent volumetric geometry. Most of the volume rendering mappers draw their results during this third method. The last method is to render any 2D annotation or overlays. Each of these methods return an integer value indicating whether or not this render method was applied to this data.

Reimplemented from vtkProp.

◆ SetHeading()

virtual void vtkCompassRepresentation::SetHeading ( double  value)
virtual

◆ GetHeading()

virtual double vtkCompassRepresentation::GetHeading ( )
virtual

◆ SetTilt()

virtual void vtkCompassRepresentation::SetTilt ( double  value)
virtual

◆ GetTilt()

virtual double vtkCompassRepresentation::GetTilt ( )
virtual

◆ UpdateTilt()

virtual void vtkCompassRepresentation::UpdateTilt ( double  time)
virtual

◆ EndTilt()

virtual void vtkCompassRepresentation::EndTilt ( )
virtual

◆ SetDistance()

virtual void vtkCompassRepresentation::SetDistance ( double  value)
virtual

◆ GetDistance()

virtual double vtkCompassRepresentation::GetDistance ( )
virtual

◆ UpdateDistance()

virtual void vtkCompassRepresentation::UpdateDistance ( double  time)
virtual

◆ EndDistance()

virtual void vtkCompassRepresentation::EndDistance ( )
virtual

◆ SetRenderer()

void vtkCompassRepresentation::SetRenderer ( vtkRenderer ren)
overridevirtual

Subclasses of vtkWidgetRepresentation must implement these methods.

This is considered the minimum API for a widget representation.

SetRenderer() - the renderer in which the representations draws itself.
Typically the renderer is set by the associated widget.
Use the widget's SetCurrentRenderer() method in most cases;
otherwise there is a risk of inconsistent behavior as events
and drawing may be performed in different viewports.
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.

◆ BuildRing()

void vtkCompassRepresentation::BuildRing ( )
protected

◆ BuildBackdrop()

void vtkCompassRepresentation::BuildBackdrop ( )
protected

◆ GetCenterAndUnitRadius()

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

Member Data Documentation

◆ Point1Coordinate

vtkCoordinate* vtkCompassRepresentation::Point1Coordinate
protected

Definition at line 169 of file vtkCompassRepresentation.h.

◆ Point2Coordinate

vtkCoordinate* vtkCompassRepresentation::Point2Coordinate
protected

Definition at line 170 of file vtkCompassRepresentation.h.

◆ InnerRadius

double vtkCompassRepresentation::InnerRadius
protected

Definition at line 173 of file vtkCompassRepresentation.h.

◆ OuterRadius

double vtkCompassRepresentation::OuterRadius
protected

Definition at line 174 of file vtkCompassRepresentation.h.

◆ TiltRepresentation

vtkSmartPointer<vtkCenteredSliderRepresentation> vtkCompassRepresentation::TiltRepresentation
protected

Definition at line 178 of file vtkCompassRepresentation.h.

◆ DistanceRepresentation

vtkSmartPointer<vtkCenteredSliderRepresentation> vtkCompassRepresentation::DistanceRepresentation
protected

Definition at line 179 of file vtkCompassRepresentation.h.

◆ XForm

vtkTransform* vtkCompassRepresentation::XForm
protected

Definition at line 183 of file vtkCompassRepresentation.h.

◆ Points

vtkPoints* vtkCompassRepresentation::Points
protected

Definition at line 184 of file vtkCompassRepresentation.h.

◆ Ring

vtkPolyData* vtkCompassRepresentation::Ring
protected

Definition at line 186 of file vtkCompassRepresentation.h.

◆ RingXForm

vtkTransformPolyDataFilter* vtkCompassRepresentation::RingXForm
protected

Definition at line 187 of file vtkCompassRepresentation.h.

◆ RingMapper

vtkPolyDataMapper2D* vtkCompassRepresentation::RingMapper
protected

Definition at line 188 of file vtkCompassRepresentation.h.

◆ RingActor

vtkActor2D* vtkCompassRepresentation::RingActor
protected

Definition at line 189 of file vtkCompassRepresentation.h.

◆ RingProperty

vtkProperty2D* vtkCompassRepresentation::RingProperty
protected

Definition at line 190 of file vtkCompassRepresentation.h.

◆ BackdropMapper

vtkPolyDataMapper2D* vtkCompassRepresentation::BackdropMapper
protected

Definition at line 192 of file vtkCompassRepresentation.h.

◆ Backdrop

vtkActor2D* vtkCompassRepresentation::Backdrop
protected

Definition at line 193 of file vtkCompassRepresentation.h.

◆ LabelProperty

vtkTextProperty* vtkCompassRepresentation::LabelProperty
protected

Definition at line 195 of file vtkCompassRepresentation.h.

◆ LabelActor

vtkTextActor* vtkCompassRepresentation::LabelActor
protected

Definition at line 196 of file vtkCompassRepresentation.h.

◆ StatusProperty

vtkTextProperty* vtkCompassRepresentation::StatusProperty
protected

Definition at line 197 of file vtkCompassRepresentation.h.

◆ StatusActor

vtkTextActor* vtkCompassRepresentation::StatusActor
protected

Definition at line 198 of file vtkCompassRepresentation.h.

◆ SelectedProperty

vtkProperty2D* vtkCompassRepresentation::SelectedProperty
protected

Definition at line 200 of file vtkCompassRepresentation.h.

◆ HighlightState

int vtkCompassRepresentation::HighlightState
protected

Definition at line 209 of file vtkCompassRepresentation.h.

◆ Heading

double vtkCompassRepresentation::Heading
protected

Definition at line 211 of file vtkCompassRepresentation.h.

◆ Tilt

double vtkCompassRepresentation::Tilt
protected

Definition at line 212 of file vtkCompassRepresentation.h.

◆ Distance

double vtkCompassRepresentation::Distance
protected

Definition at line 213 of file vtkCompassRepresentation.h.


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