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
enum	Axis { NONE = -1 , XAxis = 0 , YAxis = 1 , ZAxis = 2 }
	Axis labels. More...

typedef vtkProp	Superclass
	Standard methods for instances of this class.

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
void	SetThetaResolution (int r)
	Set/Get the resolution of the sphere in the theta direction.

int	GetThetaResolution ()

void	SetPhiResolution (int r)
	Set/Get the resolution of the sphere in the phi direction.

int	GetPhiResolution ()

void	SetCenter (double c[3])
	Set/Get the center position of the sphere.

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

double *	GetCenter ()

void	GetCenter (double xyz[3])

void	SetRadius (double r)
	Set/Get the radius of sphere.

double	GetRadius ()

void	GetPolyData (vtkPolyData *pd)
	Grab the polydata (including points) that defines the sphere.

void	GetSphere (vtkSphere *sphere)
	Get the spherical implicit function defined by this widget.

void	SetInteractionState (int state)
	The interaction state may be set from a widget (e.g., vtkSphereWidget2) or other object.

void	RegisterPickers () override
	Register internal Pickers in the Picking Manager.


virtual void	SetRepresentation (int)
	Set the representation (i.e., appearance) of the sphere.

virtual int	GetRepresentation ()
	Set the representation (i.e., appearance) of the sphere.

void	SetRepresentationToOff ()
	Set the representation (i.e., appearance) of the sphere.

void	SetRepresentationToWireframe ()
	Set the representation (i.e., appearance) of the sphere.

void	SetRepresentationToSurface ()
	Set the representation (i.e., appearance) of the sphere.


virtual void	SetHandleVisibility (vtkTypeBool)
	The handle sits on the surface of the sphere and may be moved around the surface by picking (left mouse) and then moving.

virtual vtkTypeBool	GetHandleVisibility ()
	The handle sits on the surface of the sphere and may be moved around the surface by picking (left mouse) and then moving.

virtual void	HandleVisibilityOn ()
	The handle sits on the surface of the sphere and may be moved around the surface by picking (left mouse) and then moving.

virtual void	HandleVisibilityOff ()
	The handle sits on the surface of the sphere and may be moved around the surface by picking (left mouse) and then moving.


void	SetHandlePosition (double handle[3])
	Set/Get the position of the handle.

void	SetHandlePosition (double x, double y, double z)
	Set/Get the position of the handle.

virtual double *	GetHandlePosition ()
	Set/Get the position of the handle.

virtual void	GetHandlePosition (double &, double &, double &)
	Set/Get the position of the handle.

virtual void	GetHandlePosition (double[3])
	Set/Get the position of the handle.


void	SetHandleDirection (double dir[3])
	Set/Get the direction vector of the handle relative to the center of the sphere.

void	SetHandleDirection (double dx, double dy, double dz)
	Set/Get the direction vector of the handle relative to the center of the sphere.

virtual double *	GetHandleDirection ()
	Set/Get the direction vector of the handle relative to the center of the sphere.

virtual void	GetHandleDirection (double &, double &, double &)
	Set/Get the direction vector of the handle relative to the center of the sphere.

virtual void	GetHandleDirection (double[3])
	Set/Get the direction vector of the handle relative to the center of the sphere.


virtual void	SetHandleText (vtkTypeBool)
	Enable/disable a label that displays the location of the handle in spherical coordinates (radius,theta,phi).

virtual vtkTypeBool	GetHandleText ()
	Enable/disable a label that displays the location of the handle in spherical coordinates (radius,theta,phi).

virtual void	HandleTextOn ()
	Enable/disable a label that displays the location of the handle in spherical coordinates (radius,theta,phi).

virtual void	HandleTextOff ()
	Enable/disable a label that displays the location of the handle in spherical coordinates (radius,theta,phi).


virtual void	SetRadialLine (vtkTypeBool)
	Enable/disable a radial line segment that joins the center of the outer sphere and the handle.

virtual vtkTypeBool	GetRadialLine ()
	Enable/disable a radial line segment that joins the center of the outer sphere and the handle.

virtual void	RadialLineOn ()
	Enable/disable a radial line segment that joins the center of the outer sphere and the handle.

virtual void	RadialLineOff ()
	Enable/disable a radial line segment that joins the center of the outer sphere and the handle.


virtual void	SetCenterCursor (bool)
	Enable/disable a center cursor Default is disabled.

virtual bool	GetCenterCursor ()
	Enable/disable a center cursor Default is disabled.

virtual void	CenterCursorOn ()
	Enable/disable a center cursor Default is disabled.

virtual void	CenterCursorOff ()
	Enable/disable a center cursor Default is disabled.


virtual vtkProperty *	GetSphereProperty ()
	Get the sphere properties.

virtual vtkProperty *	GetSelectedSphereProperty ()
	Get the sphere properties.


virtual vtkProperty *	GetHandleProperty ()
	Get the handle properties (the little ball on the sphere is the handle).

virtual vtkProperty *	GetSelectedHandleProperty ()
	Get the handle properties (the little ball on the sphere is the handle).


virtual vtkTextProperty *	GetHandleTextProperty ()
	Get the handle text property.


virtual vtkProperty *	GetRadialLineProperty ()
	Get the property of the radial line.


void	PlaceWidget (double bounds[6]) override
	These are methods that satisfy vtkWidgetRepresentation's API.

virtual void	PlaceWidget (double center[3], double handlePosition[3])
	These are methods that satisfy vtkWidgetRepresentation's API.

void	BuildRepresentation () override
	These are methods that satisfy vtkWidgetRepresentation's API.

int	ComputeInteractionState (int X, int Y, int modify=0) override
	These are methods that satisfy vtkWidgetRepresentation's API.

void	StartWidgetInteraction (double e[2]) override
	These are methods that satisfy vtkWidgetRepresentation's API.

void	WidgetInteraction (double e[2]) override
	These are methods that satisfy vtkWidgetRepresentation's API.

double *	GetBounds () override
	These are methods that satisfy vtkWidgetRepresentation's API.


void	ReleaseGraphicsResources (vtkWindow *) override
	Methods supporting, and required by, the rendering process.

int	RenderOpaqueGeometry (vtkViewport *) override
	Methods supporting, and required by, the rendering process.

int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	Methods supporting, and required by, the rendering process.

int	RenderOverlay (vtkViewport *) override
	Methods supporting, and required by, the rendering process.

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Methods supporting, and required by, the rendering process.


virtual int	GetTranslationAxis ()
	Gets/Sets the constraint axis for translations.

virtual void	SetTranslationAxis (int)
	Gets/Sets the constraint axis for translations.


void	SetXTranslationAxisOn ()
	Toggles constraint translation axis on/off.

void	SetYTranslationAxisOn ()
	Toggles constraint translation axis on/off.

void	SetZTranslationAxisOn ()
	Toggles constraint translation axis on/off.

void	SetTranslationAxisOff ()
	Toggles constraint translation axis on/off.


bool	IsTranslationConstrained ()
	Returns true if ContrainedAxis.

Public Member Functions inherited from vtkWidgetRepresentation
virtual void	PlaceWidget (double vtkNotUsed(bounds)[6])
	The following is a suggested API for widget representations.

virtual void	StartWidgetInteraction (double eventPos[2])

virtual void	WidgetInteraction (double newEventPos[2])

virtual void	EndWidgetInteraction (double newEventPos[2])

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

virtual int	GetInteractionState ()

virtual void	Highlight (int vtkNotUsed(highlightOn))

double *	GetBounds () override
	Methods to make this class behave as a vtkProp.

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkProp.

void	GetActors (vtkPropCollection *) override
	For some exporters and other other operations we must be able to collect all the actors or volumes.

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.

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.

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager.

virtual void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager.

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking.

virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking.

void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking.

virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetRenderer (vtkRenderer *ren)
	Subclasses of vtkWidgetRepresentation must implement these methods.

virtual vtkRenderer *	GetRenderer ()
	Subclasses of vtkWidgetRepresentation must implement these methods.

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

virtual double	GetPlaceFactor ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).

virtual void	SetHandleSize (double)
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).

virtual double	GetHandleSize ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).

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

virtual void	SetNeedToRender (vtkTypeBool)
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).

virtual void	NeedToRenderOn ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).

virtual void	NeedToRenderOff ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).

vtkWidgetRepresentation *	NewInstance () const
	Standard methods for instances of this class.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instances of this class.

Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkProp *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	Pick ()
	Method fires PickEvent if the prop is picked.

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.

virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.

virtual vtkMatrix4x4 *	GetMatrix ()

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.

virtual int	RenderOpaqueGeometry (vtkViewport *)
	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.

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.

virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()
	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.

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.

virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

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.

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.

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.

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.

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.

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.

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.

virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers

virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.

virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.

virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.

virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.

virtual void	PickableOn ()
	Set/Get the pickable instance variable.

virtual void	PickableOff ()
	Set/Get the pickable instance variable.

virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.

virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.

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().

virtual bool	GetUseBounds ()
	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().

virtual void	UseBoundsOn ()
	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().

virtual void	UseBoundsOff ()
	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().

virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.

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.

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

virtual int	GetNumberOfConsumers ()
	Get the number of consumers.

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.

virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.

virtual bool	IsRenderingTranslucentPolygonalGeometry ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkSphereRepresentation *	New ()
	Instantiate the class.

Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instances of this class.

static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class.

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

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
	vtkSphereRepresentation ()

	~vtkSphereRepresentation () override

void	HighlightSphere (int highlight)

void	Translate (const double p1, const double p2)

void	Scale (const double p1, const double p2, int X, int Y)

void	PlaceHandle (const double *center, double radius)

virtual void	SizeHandles ()

virtual void	AdaptCenterCursorBounds ()

void	CreateDefaultProperties ()

void	HighlightHandle (int)

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation () override

void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the widget representation currently belong.

vtkAssemblyPath *	GetAssemblyPath (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.

vtkAssemblyPath *	GetAssemblyPath3DPoint (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
virtual vtkObjectBase *	NewInstanceInternal () const

	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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	LastEventPosition [3]

int	TranslationAxis

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

vtkTypeBool	HandleVisibility

double	HandleDirection [3]

double	HandlePosition [3]

vtkTypeBool	HandleText

vtkTextProperty *	HandleTextProperty

vtkTextMapper *	HandleTextMapper

vtkActor2D *	HandleTextActor

vtkTypeBool	RadialLine

vtkProperty *	RadialLineProperty

vtkLineSource *	RadialLineSource

vtkPolyDataMapper *	RadialLineMapper

vtkActor *	RadialLineActor

vtkActor *	CenterActor

vtkPolyDataMapper *	CenterMapper

vtkCursor3D *	CenterCursorSource

bool	CenterCursor

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

vtkTypeBool	NeedToRender

vtkTimeStamp	BuildTime

vtkNew< vtkTransform >	TempTransform

vtkNew< vtkMatrix4x4 >	TempMatrix

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

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

vtkShaderProperty *	ShaderProperty

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for type information and to print out the contents of the class.

static vtkSphereRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for type information and to print out the contents of the class.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for type information and to print out the contents of the class.

vtkSphereRepresentation *	NewInstance () const
	Standard methods for type information and to print out the contents of the class.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for type information and to print out the contents of the class.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for type information and to print out the contents of the class.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Online Examples:

SphereWidget

SphereWidget2

SphereWidgetEvents

Definition at line 114 of file vtkSphereRepresentation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkWidgetRepresentation vtkSphereRepresentation::Superclass

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

Definition at line 126 of file vtkSphereRepresentation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
Outside
MovingHandle
OnSphere
Translating
Scaling

Definition at line 131 of file vtkSphereRepresentation.h.

Constructor & Destructor Documentation

◆ vtkSphereRepresentation()

vtkSphereRepresentation::vtkSphereRepresentation ( )

protected

◆ ~vtkSphereRepresentation()

vtkSphereRepresentation::~vtkSphereRepresentation ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSphereRepresentation * vtkSphereRepresentation::New ( )

static

Instantiate the class.

◆ IsTypeOf()

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

static

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

◆ IsA()

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

virtual

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

Reimplemented from vtkWidgetRepresentation.

◆ SafeDownCast()

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

static

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSphereRepresentation::NewInstanceInternal ( ) const

protectedvirtual

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

Reimplemented from vtkWidgetRepresentation.

◆ NewInstance()

vtkSphereRepresentation * vtkSphereRepresentation::NewInstance ( ) const

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

◆ PrintSelf()

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

overridevirtual

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

Reimplemented from vtkObject.

◆ SetRepresentation()

virtual void vtkSphereRepresentation::SetRepresentation ( int )

virtual

Set the representation (i.e., appearance) of the sphere.

Different representations are useful depending on the application.

◆ GetRepresentation()

virtual int vtkSphereRepresentation::GetRepresentation ( )

virtual

Set the representation (i.e., appearance) of the sphere.

Different representations are useful depending on the application.

◆ SetRepresentationToOff()

void vtkSphereRepresentation::SetRepresentationToOff ( )

inline

Set the representation (i.e., appearance) of the sphere.

Different representations are useful depending on the application.

Definition at line 147 of file vtkSphereRepresentation.h.

◆ SetRepresentationToWireframe()

void vtkSphereRepresentation::SetRepresentationToWireframe ( )

inline

Set the representation (i.e., appearance) of the sphere.

Different representations are useful depending on the application.

Definition at line 148 of file vtkSphereRepresentation.h.

◆ SetRepresentationToSurface()

void vtkSphereRepresentation::SetRepresentationToSurface ( )

inline

Set the representation (i.e., appearance) of the sphere.

Different representations are useful depending on the application.

Definition at line 149 of file vtkSphereRepresentation.h.

◆ SetThetaResolution()

void vtkSphereRepresentation::SetThetaResolution ( int r )

inline

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

Definition at line 155 of file vtkSphereRepresentation.h.

◆ GetThetaResolution()

int vtkSphereRepresentation::GetThetaResolution ( )

inline

Definition at line 156 of file vtkSphereRepresentation.h.

◆ SetPhiResolution()

void vtkSphereRepresentation::SetPhiResolution ( int r )

inline

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

Definition at line 161 of file vtkSphereRepresentation.h.

◆ GetPhiResolution()

int vtkSphereRepresentation::GetPhiResolution ( )

inline

Definition at line 162 of file vtkSphereRepresentation.h.

◆ SetCenter() [1/2]

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.

◆ SetCenter() [2/2]

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

inline

Definition at line 170 of file vtkSphereRepresentation.h.

◆ GetCenter() [1/2]

double * vtkSphereRepresentation::GetCenter ( )

inline

Definition at line 178 of file vtkSphereRepresentation.h.

◆ GetCenter() [2/2]

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

inline

Definition at line 179 of file vtkSphereRepresentation.h.

◆ SetRadius()

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.

◆ GetRadius()

double vtkSphereRepresentation::GetRadius ( )

inline

Definition at line 186 of file vtkSphereRepresentation.h.

◆ SetHandleVisibility()

virtual void vtkSphereRepresentation::SetHandleVisibility ( vtkTypeBool )

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.

◆ GetHandleVisibility()

virtual vtkTypeBool 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.

◆ HandleVisibilityOn()

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.

◆ HandleVisibilityOff()

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.

◆ SetHandlePosition() [1/2]

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.

◆ SetHandlePosition() [2/2]

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 206 of file vtkSphereRepresentation.h.

◆ GetHandlePosition() [1/3]

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.

◆ GetHandlePosition() [2/3]

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.

◆ GetHandlePosition() [3/3]

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.

◆ SetHandleDirection() [1/2]

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.

◆ SetHandleDirection() [2/2]

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 224 of file vtkSphereRepresentation.h.

◆ GetHandleDirection() [1/3]

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.

◆ GetHandleDirection() [2/3]

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.

◆ GetHandleDirection() [3/3]

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.

◆ SetHandleText()

virtual void vtkSphereRepresentation::SetHandleText ( vtkTypeBool )

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.

◆ GetHandleText()

virtual vtkTypeBool 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.

◆ HandleTextOn()

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.

◆ HandleTextOff()

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.

◆ SetRadialLine()

virtual void vtkSphereRepresentation::SetRadialLine ( vtkTypeBool )

virtual

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

◆ GetRadialLine()

virtual vtkTypeBool vtkSphereRepresentation::GetRadialLine ( )

virtual

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

◆ RadialLineOn()

virtual void vtkSphereRepresentation::RadialLineOn ( )

virtual

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

◆ RadialLineOff()

virtual void vtkSphereRepresentation::RadialLineOff ( )

virtual

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

◆ SetCenterCursor()

virtual void vtkSphereRepresentation::SetCenterCursor ( bool )

virtual

Enable/disable a center cursor Default is disabled.

◆ GetCenterCursor()

virtual bool vtkSphereRepresentation::GetCenterCursor ( )

virtual

Enable/disable a center cursor Default is disabled.

◆ CenterCursorOn()

virtual void vtkSphereRepresentation::CenterCursorOn ( )

virtual

Enable/disable a center cursor Default is disabled.

◆ CenterCursorOff()

virtual void vtkSphereRepresentation::CenterCursorOff ( )

virtual

Enable/disable a center cursor Default is disabled.

◆ GetPolyData()

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.

◆ GetSphere()

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.

◆ GetSphereProperty()

virtual vtkProperty * vtkSphereRepresentation::GetSphereProperty ( )

virtual

Get the sphere properties.

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

◆ GetSelectedSphereProperty()

virtual vtkProperty * vtkSphereRepresentation::GetSelectedSphereProperty ( )

virtual

Get the sphere properties.

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

◆ GetHandleProperty()

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.

◆ GetSelectedHandleProperty()

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.

◆ GetHandleTextProperty()

virtual vtkTextProperty * vtkSphereRepresentation::GetHandleTextProperty ( )

virtual

Get the handle text property.

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

◆ GetRadialLineProperty()

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.

◆ SetInteractionState()

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.