defining the representation for a vtkImplicitCylinderWidget More...

#include <vtkImplicitCylinderRepresentation.h>

Inheritance diagram for vtkImplicitCylinderRepresentation:

Collaboration diagram for vtkImplicitCylinderRepresentation:

Public Types
enum	_InteractionState { Outside =0, Moving, MovingOutline, MovingCenter, RotatingAxis, AdjustingRadius, 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	GetCylinder (vtkCylinder *cyl)

void	GetPolyData (vtkPolyData *pd)

void	UpdatePlacement (void)

void	BumpCylinder (int dir, double factor)

void	PushCylinder (double distance)


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

void	SetCenter (double x[3])

double *	GetCenter ()

void	GetCenter (double xyz[3])


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

void	SetAxis (double a[3])

double *	GetAxis ()

void	GetAxis (double a[3])


void	SetRadius (double r)

double	GetRadius ()


virtual void	SetMinRadius (double)

virtual double	GetMinRadius ()

virtual void	SetMaxRadius (double)

virtual double	GetMaxRadius ()


void	SetAlongXAxis (int)

virtual int	GetAlongXAxis ()

virtual void	AlongXAxisOn ()

virtual void	AlongXAxisOff ()

void	SetAlongYAxis (int)

virtual int	GetAlongYAxis ()

virtual void	AlongYAxisOn ()

virtual void	AlongYAxisOff ()

void	SetAlongZAxis (int)

virtual int	GetAlongZAxis ()

virtual void	AlongZAxisOn ()

virtual void	AlongZAxisOff ()


void	SetDrawCylinder (int plane)

virtual int	GetDrawCylinder ()

virtual void	DrawCylinderOn ()

virtual void	DrawCylinderOff ()


virtual void	SetResolution (int)

virtual int	GetResolution ()


virtual void	SetTubing (int)

virtual int	GetTubing ()

virtual void	TubingOn ()

virtual void	TubingOff ()


virtual void	SetOutlineTranslation (int)

virtual int	GetOutlineTranslation ()

virtual void	OutlineTranslationOn ()

virtual void	OutlineTranslationOff ()


virtual void	SetOutsideBounds (int)

virtual int	GetOutsideBounds ()

virtual void	OutsideBoundsOn ()

virtual void	OutsideBoundsOff ()


virtual void	SetScaleEnabled (int)

virtual int	GetScaleEnabled ()

virtual void	ScaleEnabledOn ()

virtual void	ScaleEnabledOff ()


virtual vtkProperty *	GetAxisProperty ()

virtual vtkProperty *	GetSelectedAxisProperty ()


virtual vtkProperty *	GetCylinderProperty ()

virtual vtkProperty *	GetSelectedCylinderProperty ()


virtual vtkProperty *	GetOutlineProperty ()

virtual vtkProperty *	GetSelectedOutlineProperty ()


virtual vtkProperty *	GetEdgesProperty ()


void	SetEdgeColor (vtkLookupTable *)

void	SetEdgeColor (double, double, double)

void	SetEdgeColor (double x[3])


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

virtual void	PlaceWidget (double bounds[6])

virtual void	BuildRepresentation ()

virtual void	StartWidgetInteraction (double eventPos[2])

virtual void	WidgetInteraction (double newEventPos[2])

virtual void	EndWidgetInteraction (double newEventPos[2])


virtual double *	GetBounds ()

virtual void	GetActors (vtkPropCollection *pc)

virtual void	ReleaseGraphicsResources (vtkWindow *)

virtual int	RenderOpaqueGeometry (vtkViewport *)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	HasTranslucentPolygonalGeometry ()


virtual void	SetBumpDistance (double)

virtual double	GetBumpDistance ()


virtual void	SetInteractionState (int)


virtual void	SetRepresentationState (int)

virtual int	GetRepresentationState ()

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 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	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 int	RenderOverlay (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 vtkImplicitCylinderRepresentation *	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
	vtkImplicitCylinderRepresentation ()

	~vtkImplicitCylinderRepresentation ()

void	HighlightOutline (int highlight)

void	HighlightCylinder (int highlight)

void	HighlightNormal (int highlight)

virtual void	RegisterPickers ()

void	ConstrainCenter (double x[3])

void	Rotate (double X, double Y, double p1, double p2, double *vpn)

void	TranslateCylinder (double p1, double p2)

void	TranslateOutline (double p1, double p2)

void	TranslateCenter (double p1, double p2)

void	ScaleRadius (double p1, double p2)

void	AdjustRadius (double X, double Y, double p1, double p2)

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

void	SizeHandles ()

void	CreateDefaultProperties ()

void	BuildCylinder ()

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
int	RepresentationState

double	LastEventPosition [3]

double	MinRadius

double	MaxRadius

double	BumpDistance

int	AlongXAxis

int	AlongYAxis

int	AlongZAxis

vtkCylinder *	Cylinder

int	Resolution

vtkImageData *	Box

vtkOutlineFilter *	Outline

vtkPolyDataMapper *	OutlineMapper

vtkActor *	OutlineActor

int	OutlineTranslation

int	ScaleEnabled

int	OutsideBounds

vtkPolyData *	Cyl

vtkPolyDataMapper *	CylMapper

vtkActor *	CylActor

int	DrawCylinder

vtkFeatureEdges *	Edges

vtkTubeFilter *	EdgesTuber

vtkPolyDataMapper *	EdgesMapper

vtkActor *	EdgesActor

int	Tubing

vtkConeSource *	ConeSource

vtkPolyDataMapper *	ConeMapper

vtkActor *	ConeActor

vtkLineSource *	LineSource

vtkPolyDataMapper *	LineMapper

vtkActor *	LineActor

vtkConeSource *	ConeSource2

vtkPolyDataMapper *	ConeMapper2

vtkActor *	ConeActor2

vtkLineSource *	LineSource2

vtkPolyDataMapper *	LineMapper2

vtkActor *	LineActor2

vtkSphereSource *	Sphere

vtkPolyDataMapper *	SphereMapper

vtkActor *	SphereActor

vtkCellPicker *	Picker

vtkCellPicker *	CylPicker

vtkTransform *	Transform

vtkProperty *	AxisProperty

vtkProperty *	SelectedAxisProperty

vtkProperty *	CylinderProperty

vtkProperty *	SelectedCylinderProperty

vtkProperty *	OutlineProperty

vtkProperty *	SelectedOutlineProperty

vtkProperty *	EdgesProperty

vtkBox *	BoundingBox

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

virtual int	IsA (const char *type)

vtkImplicitCylinderRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

defining the representation for a vtkImplicitCylinderWidget

This class is a concrete representation for the vtkImplicitCylinderWidget. It represents an infinite cylinder defined by a radius, a center, and an axis. The cylinder is placed within its associated bounding box and the intersection of the cylinder with the bounding box is shown to visually indicate the orientation and position of the representation. This cylinder representation can be manipulated by using the vtkImplicitCylinderWidget to adjust the cylinder radius, axis, and/or center point. (Note that the bounding box is defined during invocation of the superclass' PlaceWidget() method.)

To use this representation, you normally specify a radius, center, and axis. Optionally you can specify a minimum and maximum radius, and a resolution for the cylinder. Finally, place the widget and its representation in the scene using PlaceWidget().

See also: vtkImplicitCylinderWidget vtkImplicitPlaneWidget vtkImplicitPlaneWidget

Tests:: vtkImplicitCylinderRepresentation (Tests)

Definition at line 67 of file vtkImplicitCylinderRepresentation.h.

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkImplicitCylinderRepresentation::Superclass

Standard methods for the class.

Definition at line 75 of file vtkImplicitCylinderRepresentation.h.

Member Enumeration Documentation

enum vtkImplicitCylinderRepresentation::_InteractionState

Enumerator
Outside
Moving
MovingOutline
MovingCenter
RotatingAxis
AdjustingRadius
Scaling

Definition at line 271 of file vtkImplicitCylinderRepresentation.h.

Constructor & Destructor Documentation

vtkImplicitCylinderRepresentation::vtkImplicitCylinderRepresentation ( )

protected

vtkImplicitCylinderRepresentation::~vtkImplicitCylinderRepresentation ( )

protected

Member Function Documentation

static vtkImplicitCylinderRepresentation* vtkImplicitCylinderRepresentation::New ( )

static

Instantiate the class.

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

static

Standard methods for the class.

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

virtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

static

Standard methods for the class.

virtual vtkObjectBase* vtkImplicitCylinderRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

vtkImplicitCylinderRepresentation* vtkImplicitCylinderRepresentation::NewInstance ( ) const

Standard methods for the class.

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

virtual

Standard methods for the class.

Reimplemented from vtkObject.

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

Get the center of the cylinder. The center is located along the cylinder axis.

void vtkImplicitCylinderRepresentation::SetCenter ( double x[3] )

Get the center of the cylinder. The center is located along the cylinder axis.

double* vtkImplicitCylinderRepresentation::GetCenter ( )

Get the center of the cylinder. The center is located along the cylinder axis.

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

Get the center of the cylinder. The center is located along the cylinder axis.

void vtkImplicitCylinderRepresentation::SetAxis	(	double	x,
		double	y,
		double	z
	)

Set/Get the axis of rotation for the cylinder. If the axis is not specified as a unit vector, it will be normalized.

void vtkImplicitCylinderRepresentation::SetAxis ( double a[3] )

Set/Get the axis of rotation for the cylinder. If the axis is not specified as a unit vector, it will be normalized.

double* vtkImplicitCylinderRepresentation::GetAxis ( )

Set/Get the axis of rotation for the cylinder. If the axis is not specified as a unit vector, it will be normalized.

void vtkImplicitCylinderRepresentation::GetAxis ( double a[3] )

Set/Get the axis of rotation for the cylinder. If the axis is not specified as a unit vector, it will be normalized.

void vtkImplicitCylinderRepresentation::SetRadius ( double r )

Set/Get the radius of the cylinder. Note that if the radius is too big the cylinder will be outside of the bounding box.

double vtkImplicitCylinderRepresentation::GetRadius ( )

Set/Get the radius of the cylinder. Note that if the radius is too big the cylinder will be outside of the bounding box.

virtual void vtkImplicitCylinderRepresentation::SetMinRadius ( double )

virtual

Set/Get the minimum and maximum radius of the cylinder. This helps prevent the cylinder from "disappearing" during interaction. Note that the minimum and maximum radius is specified as a fraction of the diagonal length of the widget bounding box.

virtual double vtkImplicitCylinderRepresentation::GetMinRadius ( )

virtual

Set/Get the minimum and maximum radius of the cylinder. This helps prevent the cylinder from "disappearing" during interaction. Note that the minimum and maximum radius is specified as a fraction of the diagonal length of the widget bounding box.

virtual void vtkImplicitCylinderRepresentation::SetMaxRadius ( double )

virtual

Set/Get the minimum and maximum radius of the cylinder. This helps prevent the cylinder from "disappearing" during interaction. Note that the minimum and maximum radius is specified as a fraction of the diagonal length of the widget bounding box.

virtual double vtkImplicitCylinderRepresentation::GetMaxRadius ( )

virtual

Set/Get the minimum and maximum radius of the cylinder. This helps prevent the cylinder from "disappearing" during interaction. Note that the minimum and maximum radius is specified as a fraction of the diagonal length of the widget bounding box.

void vtkImplicitCylinderRepresentation::SetAlongXAxis ( int )