vtkSphereRepresentation Class Reference

a class defining the representation for the vtkSphereWidget2 More...

#include <vtkSphereRepresentation.h>

Inheritance diagram for vtkSphereRepresentation:

Collaboration diagram for vtkSphereRepresentation:

Public Types
enum	{   Outside =0, MovingHandle, OnSphere, Translating,   Scaling }
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
void	GetPolyData (vtkPolyData *pd)
void	GetSphere (vtkSphere *sphere)
void	SetInteractionState (int state)
virtual void	SetRepresentation (int)
virtual int	GetRepresentation ()
void	SetRepresentationToOff ()
void	SetRepresentationToWireframe ()
void	SetRepresentationToSurface ()
void	SetThetaResolution (int r)
int	GetThetaResolution ()
void	SetPhiResolution (int r)
int	GetPhiResolution ()
void	SetCenter (double c[3])
void	SetCenter (double x, double y, double z)
double *	GetCenter ()
void	GetCenter (double xyz[3])
void	SetRadius (double r)
double	GetRadius ()
virtual void	SetHandleVisibility (int)
virtual int	GetHandleVisibility ()
virtual void	HandleVisibilityOn ()
virtual void	HandleVisibilityOff ()
void	SetHandlePosition (double handle[3])
void	SetHandlePosition (double x, double y, double z)
virtual double *	GetHandlePosition ()
virtual void	GetHandlePosition (double &, double &, double &)
virtual void	GetHandlePosition (double[3])
void	SetHandleDirection (double dir[3])
void	SetHandleDirection (double dx, double dy, double dz)
virtual double *	GetHandleDirection ()
virtual void	GetHandleDirection (double &, double &, double &)
virtual void	GetHandleDirection (double[3])
virtual void	SetHandleText (int)
virtual int	GetHandleText ()
virtual void	HandleTextOn ()
virtual void	HandleTextOff ()
virtual void	SetRadialLine (int)
virtual int	GetRadialLine ()
virtual void	RadialLineOn ()
virtual void	RadialLineOff ()
virtual vtkProperty *	GetSphereProperty ()
virtual vtkProperty *	GetSelectedSphereProperty ()
virtual vtkProperty *	GetHandleProperty ()
virtual vtkProperty *	GetSelectedHandleProperty ()
virtual vtkTextProperty *	GetHandleTextProperty ()
virtual vtkProperty *	GetRadialLineProperty ()
virtual void	PlaceWidget (double bounds[6])
virtual void	PlaceWidget (double center[3], double handlePosition[3])
virtual void	BuildRepresentation ()
virtual int	ComputeInteractionState (int X, int Y, int modify=0)
virtual void	StartWidgetInteraction (double e[2])
virtual void	WidgetInteraction (double e[2])
virtual double *	GetBounds ()
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual int	RenderOpaqueGeometry (vtkViewport *)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	RenderOverlay (vtkViewport *)
virtual int	HasTranslucentPolygonalGeometry ()
Public Member Functions inherited from vtkWidgetRepresentation
virtual void	PickingManagedOn ()
virtual void	PickingManagedOff ()
virtual void	SetPickingManaged (bool)
virtual bool	GetPickingManaged ()
virtual void	SetRenderer (vtkRenderer *ren)
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 void	ShallowCopy (vtkProp *prop)
virtual void	GetActors (vtkPropCollection *)
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))
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	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 vtkSphereRepresentation *	New ()
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
	vtkSphereRepresentation ()
	~vtkSphereRepresentation ()
void	HighlightSphere (int highlight)
virtual void	RegisterPickers ()
void	Translate (double *p1, double *p2)
void	Scale (double *p1, double *p2, int X, int Y)
void	PlaceHandle (double *center, double radius)
virtual void	SizeHandles ()
void	CreateDefaultProperties ()
void	HighlightHandle (int)
Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()
	~vtkWidgetRepresentation ()
void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])
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
double	LastEventPosition [3]
vtkActor *	SphereActor
vtkPolyDataMapper *	SphereMapper
vtkSphereSource *	SphereSource
int	Representation
vtkCellPicker *	HandlePicker
vtkCellPicker *	SpherePicker
double	LastPickPosition [3]
vtkProperty *	SphereProperty
vtkProperty *	SelectedSphereProperty
vtkProperty *	HandleProperty
vtkProperty *	SelectedHandleProperty
vtkActor *	HandleActor
vtkPolyDataMapper *	HandleMapper
vtkSphereSource *	HandleSource
int	HandleVisibility
double	HandleDirection [3]
double	HandlePosition [3]
int	HandleText
vtkTextProperty *	HandleTextProperty
vtkTextMapper *	HandleTextMapper
vtkActor2D *	HandleTextActor
int	RadialLine
vtkProperty *	RadialLineProperty
vtkLineSource *	RadialLineSource
vtkPolyDataMapper *	RadialLineMapper
vtkActor *	RadialLineActor
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 vtkWidgetRepresentation	Superclass
static int	IsTypeOf (const char *type)
static vtkSphereRepresentation *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkSphereRepresentation *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

a class defining the representation for the vtkSphereWidget2

This class is a concrete representation for the vtkSphereWidget2. It represents a sphere with an optional handle. Through interaction with the widget, the sphere can be arbitrarily positioned and scaled in 3D space; and the handle can be moved on the surface of the sphere. Typically the vtkSphereWidget2/vtkSphereRepresentation are used to position a sphere for the purpose of extracting, cutting or clipping data; or the handle is moved on the sphere to position a light or camera.

To use this representation, you normally use the PlaceWidget() method to position the widget at a specified region in space. It is also possible to set the center of the sphere, a radius, and/or a handle position.

Warning

Note that the representation is overconstrained in that the center and radius of the sphere can be defined, this information plus the handle direction defines the geometry of the representation. Alternatively, the user may specify the center of the sphere plus the handle position.

This class, and vtkSphereWidget2, are second generation VTK widgets. An earlier version of this functionality was defined in the class vtkSphereWidget.

See also

vtkSphereWidget2 vtkSphereWidget

Tests:

vtkSphereRepresentation (Tests)

Definition at line 76 of file vtkSphereRepresentation.h.

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkSphereRepresentation::Superclass

Standard methods for type information and to print out the contents of the class.

Definition at line 85 of file vtkSphereRepresentation.h.

Member Enumeration Documentation

anonymous enum

Enumerator
Outside
MovingHandle
OnSphere
Translating
Scaling

Definition at line 90 of file vtkSphereRepresentation.h.

Constructor & Destructor Documentation

vtkSphereRepresentation::vtkSphereRepresentation ( )

protected

vtkSphereRepresentation::~vtkSphereRepresentation ( )

protected

Member Function Documentation

static vtkSphereRepresentation* vtkSphereRepresentation::New ( )

static

Instantiate the class.

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

static

Standard methods for type information and to print out the contents of the class.

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

virtual

Standard methods for type information and to print out the contents of the class.

Reimplemented from vtkWidgetRepresentation.

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

static

Standard methods for type information and to print out the contents of the class.

virtual vtkObjectBase* vtkSphereRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for type information and to print out the contents of the class.

Reimplemented from vtkWidgetRepresentation.

vtkSphereRepresentation* vtkSphereRepresentation::NewInstance

(

)

const

Standard methods for type information and to print out the contents of the class.

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

virtual

Standard methods for type information and to print out the contents of the class.

Reimplemented from vtkObject.

virtual void vtkSphereRepresentation::SetRepresentation ( int  )

virtual

Set the representation (i.e., appearance) of the sphere. Different representations are useful depending on the application.

virtual int vtkSphereRepresentation::GetRepresentation ( )

virtual

Set the representation (i.e., appearance) of the sphere. Different representations are useful depending on the application.

void vtkSphereRepresentation::SetRepresentationToOff ( )

inline

Set the representation (i.e., appearance) of the sphere. Different representations are useful depending on the application.

Definition at line 98 of file vtkSphereRepresentation.h.

void vtkSphereRepresentation::SetRepresentationToWireframe ( )

inline

Set the representation (i.e., appearance) of the sphere. Different representations are useful depending on the application.

Definition at line 100 of file vtkSphereRepresentation.h.

void vtkSphereRepresentation::SetRepresentationToSurface ( )

inline

Set the representation (i.e., appearance) of the sphere. Different representations are useful depending on the application.

Definition at line 102 of file vtkSphereRepresentation.h.

void vtkSphereRepresentation::SetThetaResolution ( int  r )

inline

Set/Get the resolution of the sphere in the theta direction.

Definition at line 108 of file vtkSphereRepresentation.h.

int vtkSphereRepresentation::GetThetaResolution ( )

inline

Set/Get the resolution of the sphere in the theta direction.

Definition at line 110 of file vtkSphereRepresentation.h.

void vtkSphereRepresentation::SetPhiResolution ( int  r )

inline

Set/Get the resolution of the sphere in the phi direction.

Definition at line 116 of file vtkSphereRepresentation.h.

int vtkSphereRepresentation::GetPhiResolution ( )

inline

Set/Get the resolution of the sphere in the phi direction.

Definition at line 118 of file vtkSphereRepresentation.h.

void vtkSphereRepresentation::SetCenter

(

double

c[3]

)

Set/Get the center position of the sphere. Note that this may adjust the direction from the handle to the center, as well as the radius of the sphere.

void vtkSphereRepresentation::SetCenter ( double  x, double  y, double  z  )

inline

Set/Get the center position of the sphere. Note that this may adjust the direction from the handle to the center, as well as the radius of the sphere.

Definition at line 127 of file vtkSphereRepresentation.h.

double* vtkSphereRepresentation::GetCenter ( )

inline

Set/Get the center position of the sphere. Note that this may adjust the direction from the handle to the center, as well as the radius of the sphere.

Definition at line 129 of file vtkSphereRepresentation.h.

void vtkSphereRepresentation::GetCenter ( double  xyz[3] )

inline

Set/Get the center position of the sphere. Note that this may adjust the direction from the handle to the center, as well as the radius of the sphere.

Definition at line 131 of file vtkSphereRepresentation.h.

void vtkSphereRepresentation::SetRadius

(

double

r

)

Set/Get the radius of sphere. Default is 0.5. Note that this may modify the position of the handle based on the handle direction.

double vtkSphereRepresentation::GetRadius ( )

inline

Set/Get the radius of sphere. Default is 0.5. Note that this may modify the position of the handle based on the handle direction.

Definition at line 139 of file vtkSphereRepresentation.h.

virtual void vtkSphereRepresentation::SetHandleVisibility ( int  )

virtual

The handle sits on the surface of the sphere and may be moved around the surface by picking (left mouse) and then moving. The position of the handle can be retrieved, this is useful for positioning cameras and lights. By default, the handle is turned off.

virtual int vtkSphereRepresentation::GetHandleVisibility ( )

virtual

The handle sits on the surface of the sphere and may be moved around the surface by picking (left mouse) and then moving. The position of the handle can be retrieved, this is useful for positioning cameras and lights. By default, the handle is turned off.

virtual void vtkSphereRepresentation::HandleVisibilityOn ( )

virtual

The handle sits on the surface of the sphere and may be moved around the surface by picking (left mouse) and then moving. The position of the handle can be retrieved, this is useful for positioning cameras and lights. By default, the handle is turned off.

virtual void vtkSphereRepresentation::HandleVisibilityOff ( )

virtual

The handle sits on the surface of the sphere and may be moved around the surface by picking (left mouse) and then moving. The position of the handle can be retrieved, this is useful for positioning cameras and lights. By default, the handle is turned off.

void vtkSphereRepresentation::SetHandlePosition

(

double

handle[3]

)

Set/Get the position of the handle. Note that this may adjust the radius of the sphere and the handle direction.

void vtkSphereRepresentation::SetHandlePosition ( double  x, double  y, double  z  )

inline

Set/Get the position of the handle. Note that this may adjust the radius of the sphere and the handle direction.

Definition at line 157 of file vtkSphereRepresentation.h.

virtual double* vtkSphereRepresentation::GetHandlePosition ( )

virtual

Set/Get the position of the handle. Note that this may adjust the radius of the sphere and the handle direction.

virtual void vtkSphereRepresentation::GetHandlePosition ( double &  , double &  , double &    )

virtual

Set/Get the position of the handle. Note that this may adjust the radius of the sphere and the handle direction.

virtual void vtkSphereRepresentation::GetHandlePosition ( double  [3] )

virtual

Set/Get the position of the handle. Note that this may adjust the radius of the sphere and the handle direction.

void vtkSphereRepresentation::SetHandleDirection

(

double

dir[3]

)

Set/Get the direction vector of the handle relative to the center of the sphere. Setting the direction may affect the position of the handle but will not affect the radius or position of the sphere.

void vtkSphereRepresentation::SetHandleDirection ( double  dx, double  dy, double  dz  )

inline

Set/Get the direction vector of the handle relative to the center of the sphere. Setting the direction may affect the position of the handle but will not affect the radius or position of the sphere.

Definition at line 167 of file vtkSphereRepresentation.h.

virtual double* vtkSphereRepresentation::GetHandleDirection ( )

virtual

Set/Get the direction vector of the handle relative to the center of the sphere. Setting the direction may affect the position of the handle but will not affect the radius or position of the sphere.

virtual void vtkSphereRepresentation::GetHandleDirection ( double &  , double &  , double &    )

virtual

Set/Get the direction vector of the handle relative to the center of the sphere. Setting the direction may affect the position of the handle but will not affect the radius or position of the sphere.

virtual void vtkSphereRepresentation::GetHandleDirection ( double  [3] )

virtual

Set/Get the direction vector of the handle relative to the center of the sphere. Setting the direction may affect the position of the handle but will not affect the radius or position of the sphere.

virtual void vtkSphereRepresentation::SetHandleText ( int  )

virtual

Enable/disable a label that displays the location of the handle in spherical coordinates (radius,theta,phi). The two angles, theta and phi, are displayed in degrees. Note that phi is measured from the north pole down towards the equator; and theta is the angle around the north/south axis.

virtual int vtkSphereRepresentation::GetHandleText ( )

virtual

Enable/disable a label that displays the location of the handle in spherical coordinates (radius,theta,phi). The two angles, theta and phi, are displayed in degrees. Note that phi is measured from the north pole down towards the equator; and theta is the angle around the north/south axis.

virtual void vtkSphereRepresentation::HandleTextOn ( )

virtual

Enable/disable a label that displays the location of the handle in spherical coordinates (radius,theta,phi). The two angles, theta and phi, are displayed in degrees. Note that phi is measured from the north pole down towards the equator; and theta is the angle around the north/south axis.

virtual void vtkSphereRepresentation::HandleTextOff ( )

virtual

Enable/disable a label that displays the location of the handle in spherical coordinates (radius,theta,phi). The two angles, theta and phi, are displayed in degrees. Note that phi is measured from the north pole down towards the equator; and theta is the angle around the north/south axis.

virtual void vtkSphereRepresentation::SetRadialLine ( int  )

virtual

Enable/disable a radial line segment that joins the center of the outer sphere and the handle.

virtual int vtkSphereRepresentation::GetRadialLine ( )

virtual

Enable/disable a radial line segment that joins the center of the outer sphere and the handle.

virtual void vtkSphereRepresentation::RadialLineOn ( )

virtual

Enable/disable a radial line segment that joins the center of the outer sphere and the handle.

virtual void vtkSphereRepresentation::RadialLineOff ( )

virtual

Enable/disable a radial line segment that joins the center of the outer sphere and the handle.

void vtkSphereRepresentation::GetPolyData

(

vtkPolyData *

pd

)

Grab the polydata (including points) that defines the sphere. The polydata consists of n+1 points, where n is the resolution of the sphere. These point values are guaranteed to be up-to-date when either the InteractionEvent or EndInteraction events are invoked. The user provides the vtkPolyData and the points and polysphere are added to it.

void vtkSphereRepresentation::GetSphere

(

vtkSphere *

sphere

)

Get the spherical implicit function defined by this widget. Note that vtkSphere is a subclass of vtkImplicitFunction, meaning that it can be used by a variety of filters to perform clipping, cutting, and selection of data.

virtual vtkProperty* vtkSphereRepresentation::GetSphereProperty ( )

virtual

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

virtual vtkProperty* vtkSphereRepresentation::GetSelectedSphereProperty ( )

virtual

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

virtual vtkProperty* vtkSphereRepresentation::GetHandleProperty ( )

virtual

Get the handle properties (the little ball on the sphere is the handle). The properties of the handle when selected and unselected can be manipulated.

virtual vtkProperty* vtkSphereRepresentation::GetSelectedHandleProperty ( )

virtual

Get the handle properties (the little ball on the sphere is the handle). The properties of the handle when selected and unselected can be manipulated.

virtual vtkTextProperty* vtkSphereRepresentation::GetHandleTextProperty ( )

virtual

Get the handle text property. This can be used to control the appearance of the handle text.

virtual vtkProperty* vtkSphereRepresentation::GetRadialLineProperty ( )

virtual

Get the property of the radial line. This can be used to control the appearance of the optional line connecting the center to the handle.

void vtkSphereRepresentation::SetInteractionState

(

int

state

)

The interaction state may be set from a widget (e.g., vtkSphereWidget2) or other object. This controls how the interaction with the widget proceeds. Normally this method is used as part of a handshaking process with the widget: First ComputeInteractionState() is invoked that returns a state based on geometric considerations (i.e., cursor near a widget feature), then based on events, the widget may modify this further.

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

virtual

These are methods that satisfy vtkWidgetRepresentation's API. Note that a version of place widget is available where the center and handle position are specified.

virtual void vtkSphereRepresentation::PlaceWidget ( double  center[3], double  handlePosition[3]  )

virtual

These are methods that satisfy vtkWidgetRepresentation's API. Note that a version of place widget is available where the center and handle position are specified.

virtual void vtkSphereRepresentation::BuildRepresentation ( )

virtual

These are methods that satisfy vtkWidgetRepresentation's API. Note that a version of place widget is available where the center and handle position are specified.

Implements vtkWidgetRepresentation.

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

virtual

These are methods that satisfy vtkWidgetRepresentation's API. Note that a version of place widget is available where the center and handle position are specified.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkSphereRepresentation::StartWidgetInteraction ( double  e[2] )

virtual

These are methods that satisfy vtkWidgetRepresentation's API. Note that a version of place widget is available where the center and handle position are specified.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkSphereRepresentation::WidgetInteraction ( double  e[2] )

virtual

These are methods that satisfy vtkWidgetRepresentation's API. Note that a version of place widget is available where the center and handle position are specified.

Reimplemented from vtkWidgetRepresentation.

virtual double* vtkSphereRepresentation::GetBounds ( )

virtual

These are methods that satisfy vtkWidgetRepresentation's API. Note that a version of place widget is available where the center and handle position are specified.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkSphereRepresentation::ReleaseGraphicsResources ( vtkWindow *  )

virtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkSphereRepresentation::RenderOpaqueGeometry ( vtkViewport *  )

virtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

virtual int vtkSphereRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport *  )

virtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

virtual int vtkSphereRepresentation::RenderOverlay ( vtkViewport *  )

virtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

virtual int vtkSphereRepresentation::HasTranslucentPolygonalGeometry ( )

virtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkWidgetRepresentation.

void vtkSphereRepresentation::HighlightSphere ( int  highlight )

protected

virtual void vtkSphereRepresentation::RegisterPickers ( )

protectedvirtual

Register internal Pickers in the Picking Manager. Must be reimplemented by concrete widget representations to register their pickers.

Reimplemented from vtkWidgetRepresentation.

void vtkSphereRepresentation::Translate ( double *  p1, double *  p2  )

protected

void vtkSphereRepresentation::Scale ( double *  p1, double *  p2, int  X, int  Y  )

protected

void vtkSphereRepresentation::PlaceHandle ( double *  center, double  radius  )

protected

virtual void vtkSphereRepresentation::SizeHandles ( )

protectedvirtual

void vtkSphereRepresentation::CreateDefaultProperties ( )

protected

void vtkSphereRepresentation::HighlightHandle ( int  )

protected

Member Data Documentation

double vtkSphereRepresentation::LastEventPosition[3]

protected

Definition at line 268 of file vtkSphereRepresentation.h.

vtkActor* vtkSphereRepresentation::SphereActor

protected

Definition at line 271 of file vtkSphereRepresentation.h.

vtkPolyDataMapper* vtkSphereRepresentation::SphereMapper

protected

Definition at line 272 of file vtkSphereRepresentation.h.

vtkSphereSource* vtkSphereRepresentation::SphereSource

protected

Definition at line 273 of file vtkSphereRepresentation.h.

int vtkSphereRepresentation::Representation

protected

Definition at line 277 of file vtkSphereRepresentation.h.

vtkCellPicker* vtkSphereRepresentation::HandlePicker

protected

Definition at line 280 of file vtkSphereRepresentation.h.

vtkCellPicker* vtkSphereRepresentation::SpherePicker

protected

Definition at line 281 of file vtkSphereRepresentation.h.

double vtkSphereRepresentation::LastPickPosition[3]

protected

Definition at line 282 of file vtkSphereRepresentation.h.

vtkProperty* vtkSphereRepresentation::SphereProperty

protected

Definition at line 295 of file vtkSphereRepresentation.h.

vtkProperty* vtkSphereRepresentation::SelectedSphereProperty

protected

Definition at line 296 of file vtkSphereRepresentation.h.

vtkProperty* vtkSphereRepresentation::HandleProperty

protected

Definition at line 297 of file vtkSphereRepresentation.h.

vtkProperty* vtkSphereRepresentation::SelectedHandleProperty

protected

Definition at line 298 of file vtkSphereRepresentation.h.

vtkActor* vtkSphereRepresentation::HandleActor

protected

Definition at line 302 of file vtkSphereRepresentation.h.

vtkPolyDataMapper* vtkSphereRepresentation::HandleMapper

protected

Definition at line 303 of file vtkSphereRepresentation.h.

vtkSphereSource* vtkSphereRepresentation::HandleSource

protected

Definition at line 304 of file vtkSphereRepresentation.h.

int vtkSphereRepresentation::HandleVisibility

protected

Definition at line 306 of file vtkSphereRepresentation.h.

double vtkSphereRepresentation::HandleDirection[3]

protected

Definition at line 307 of file vtkSphereRepresentation.h.

double vtkSphereRepresentation::HandlePosition[3]

protected

Definition at line 308 of file vtkSphereRepresentation.h.

int vtkSphereRepresentation::HandleText

protected

Definition at line 311 of file vtkSphereRepresentation.h.

vtkTextProperty* vtkSphereRepresentation::HandleTextProperty

protected

Definition at line 312 of file vtkSphereRepresentation.h.

vtkTextMapper* vtkSphereRepresentation::HandleTextMapper

protected

Definition at line 313 of file vtkSphereRepresentation.h.

vtkActor2D* vtkSphereRepresentation::HandleTextActor

protected

Definition at line 314 of file vtkSphereRepresentation.h.

int vtkSphereRepresentation::RadialLine

protected

Definition at line 317 of file vtkSphereRepresentation.h.

vtkProperty* vtkSphereRepresentation::RadialLineProperty

protected

Definition at line 318 of file vtkSphereRepresentation.h.

vtkLineSource* vtkSphereRepresentation::RadialLineSource

protected

Definition at line 319 of file vtkSphereRepresentation.h.

vtkPolyDataMapper* vtkSphereRepresentation::RadialLineMapper

protected

Definition at line 320 of file vtkSphereRepresentation.h.

vtkActor* vtkSphereRepresentation::RadialLineActor

protected

Definition at line 321 of file vtkSphereRepresentation.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Interaction/Widgets/vtkSphereRepresentation.h