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

#include <vtkImplicitPlaneRepresentation.h>

Inheritance diagram for vtkImplicitPlaneRepresentation:

Collaboration diagram for vtkImplicitPlaneRepresentation:

Public Types
enum	_InteractionState { Outside =0, Moving, MovingOutline, MovingOrigin, Rotating, Pushing, Scaling }

Public Types inherited from vtkWidgetRepresentation
typedef vtkProp	Superclass
	Standard methods for instances of this class. More...

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
void	GetPolyData (vtkPolyData *pd)
	Grab the polydata that defines the plane. More...

vtkPolyDataAlgorithm *	GetPolyDataAlgorithm ()
	Satisfies superclass API. More...

void	GetPlane (vtkPlane *plane)
	Get the implicit function for the plane by copying the origin and normal of the cut plane into the provided vtkPlane. More...

void	SetPlane (vtkPlane *plane)
	Alternative way to define the cutting plane. More...

void	UpdatePlacement (void)
	Satisfies the superclass API. More...

void	BumpPlane (int dir, double factor)
	Translate the plane in the direction of the normal by the specified BumpDistance. More...

void	PushPlane (double distance)
	Push the plane the distance specified along the normal. More...


void	SetOrigin (double x, double y, double z)
	Get the origin of the plane. More...

void	SetOrigin (double x[3])
	Get the origin of the plane. More...

double *	GetOrigin ()
	Get the origin of the plane. More...

void	GetOrigin (double xyz[3])
	Get the origin of the plane. More...


void	SetNormal (double x, double y, double z)
	Get the normal to the plane. More...

void	SetNormal (double x[3])
	Get the normal to the plane. More...

void	SetNormalToCamera ()
	Get the normal to the plane. More...

double *	GetNormal ()
	Get the normal to the plane. More...

void	GetNormal (double xyz[3])
	Get the normal to the plane. More...


void	SetNormalToXAxis (int)
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual int	GetNormalToXAxis ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual void	NormalToXAxisOn ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual void	NormalToXAxisOff ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

void	SetNormalToYAxis (int)
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual int	GetNormalToYAxis ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual void	NormalToYAxisOn ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual void	NormalToYAxisOff ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

void	SetNormalToZAxis (int)
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual int	GetNormalToZAxis ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual void	NormalToZAxisOn ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual void	NormalToZAxisOff ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...


virtual void	SetLockNormalToCamera (int)
	If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal. More...

virtual int	GetLockNormalToCamera ()
	If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal. More...

virtual void	LockNormalToCameraOn ()
	If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal. More...

virtual void	LockNormalToCameraOff ()
	If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal. More...


virtual void	SetTubing (int)
	Turn on/off tubing of the wire outline of the plane. More...

virtual int	GetTubing ()
	Turn on/off tubing of the wire outline of the plane. More...

virtual void	TubingOn ()
	Turn on/off tubing of the wire outline of the plane. More...

virtual void	TubingOff ()
	Turn on/off tubing of the wire outline of the plane. More...


void	SetDrawPlane (int plane)
	Enable/disable the drawing of the plane. More...

virtual int	GetDrawPlane ()
	Enable/disable the drawing of the plane. More...

virtual void	DrawPlaneOn ()
	Enable/disable the drawing of the plane. More...

virtual void	DrawPlaneOff ()
	Enable/disable the drawing of the plane. More...


virtual void	SetOutlineTranslation (int)
	Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button. More...

virtual int	GetOutlineTranslation ()
	Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button. More...

virtual void	OutlineTranslationOn ()
	Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button. More...

virtual void	OutlineTranslationOff ()
	Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button. More...


virtual void	SetOutsideBounds (int)
	Turn on/off the ability to move the widget outside of the bounds specified in the initial PlaceWidget() invocation. More...

virtual int	GetOutsideBounds ()
	Turn on/off the ability to move the widget outside of the bounds specified in the initial PlaceWidget() invocation. More...

virtual void	OutsideBoundsOn ()
	Turn on/off the ability to move the widget outside of the bounds specified in the initial PlaceWidget() invocation. More...

virtual void	OutsideBoundsOff ()
	Turn on/off the ability to move the widget outside of the bounds specified in the initial PlaceWidget() invocation. More...


virtual void	SetWidgetBounds (double, double, double, double, double, double)
	Set/Get the bounds of the widget representation. More...

virtual void	SetWidgetBounds (double[6])
	Set/Get the bounds of the widget representation. More...

virtual double *	GetWidgetBounds ()
	Set/Get the bounds of the widget representation. More...

virtual void	GetWidgetBounds (double &, double &, double &, double &, double &, double &)
	Set/Get the bounds of the widget representation. More...

virtual void	GetWidgetBounds (double[6])
	Set/Get the bounds of the widget representation. More...


virtual void	SetConstrainToWidgetBounds (int)
	Turn on/off whether the plane should be constrained to the widget bounds. More...

virtual int	GetConstrainToWidgetBounds ()
	Turn on/off whether the plane should be constrained to the widget bounds. More...

virtual void	ConstrainToWidgetBoundsOn ()
	Turn on/off whether the plane should be constrained to the widget bounds. More...

virtual void	ConstrainToWidgetBoundsOff ()
	Turn on/off whether the plane should be constrained to the widget bounds. More...


virtual void	SetScaleEnabled (int)
	Turn on/off the ability to scale the widget with the mouse. More...

virtual int	GetScaleEnabled ()
	Turn on/off the ability to scale the widget with the mouse. More...

virtual void	ScaleEnabledOn ()
	Turn on/off the ability to scale the widget with the mouse. More...

virtual void	ScaleEnabledOff ()
	Turn on/off the ability to scale the widget with the mouse. More...


virtual vtkProperty *	GetNormalProperty ()
	Get the properties on the normal (line and cone). More...

virtual vtkProperty *	GetSelectedNormalProperty ()
	Get the properties on the normal (line and cone). More...


virtual vtkProperty *	GetPlaneProperty ()
	Get the plane properties. More...

virtual vtkProperty *	GetSelectedPlaneProperty ()
	Get the plane properties. More...


virtual vtkProperty *	GetOutlineProperty ()
	Get the property of the outline. More...

virtual vtkProperty *	GetSelectedOutlineProperty ()
	Get the property of the outline. More...


virtual vtkProperty *	GetEdgesProperty ()
	Get the property of the intersection edges. More...


void	SetEdgeColor (vtkLookupTable *)
	Set color to the edge. More...

void	SetEdgeColor (double, double, double)
	Set color to the edge. More...

void	SetEdgeColor (double x[3])
	Set color to the edge. More...


virtual void	SetBumpDistance (double)
	Specify a translation distance used by the BumpPlane() method. More...

virtual double	GetBumpDistance ()
	Specify a translation distance used by the BumpPlane() method. More...


virtual int	ComputeInteractionState (int X, int Y, int modify=0)
	Methods to interface with the vtkSliderWidget. More...

virtual void	PlaceWidget (double bounds[6])
	Methods to interface with the vtkSliderWidget. More...

virtual void	BuildRepresentation ()
	Methods to interface with the vtkSliderWidget. More...

virtual void	StartWidgetInteraction (double eventPos[2])
	Methods to interface with the vtkSliderWidget. More...

virtual void	WidgetInteraction (double newEventPos[2])
	Methods to interface with the vtkSliderWidget. More...

virtual void	EndWidgetInteraction (double newEventPos[2])
	Methods to interface with the vtkSliderWidget. More...


virtual double *	GetBounds ()
	Methods supporting the rendering process. More...

virtual void	GetActors (vtkPropCollection *pc)
	Methods supporting the rendering process. More...

virtual void	ReleaseGraphicsResources (vtkWindow *)
	Methods supporting the rendering process. More...

virtual int	RenderOpaqueGeometry (vtkViewport *)
	Methods supporting the rendering process. More...

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
	Methods supporting the rendering process. More...

virtual int	HasTranslucentPolygonalGeometry ()
	Methods supporting the rendering process. More...


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


virtual void	SetRepresentationState (int)
	Sets the visual appearance of the representation based on the state it is in. More...

virtual int	GetRepresentationState ()
	Sets the visual appearance of the representation based on the state it is in. More...

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

virtual int	GetInteractionState ()

virtual void	Highlight (int vtkNotUsed(highlightOn))

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

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual int	RenderOverlay (vtkViewport *vtkNotUsed(viewport))

virtual int	RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport))

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport))

virtual int	RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport))

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual vtkMatrix4x4 *	GetMatrix ()

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

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

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

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

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

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

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

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

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

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

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

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

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

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...

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

virtual int	GetNumberOfConsumers ()
	Get the number of consumers. More...

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

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

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

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

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

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

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

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

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

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

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)

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

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

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

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

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

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

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

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

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

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

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

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

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

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

virtual void	Delete ()
	Delete a VTK object. More...

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

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

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

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

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

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

Static Public Member Functions inherited from vtkProp
static int	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. More...

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

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

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

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

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

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

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

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

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

Protected Member Functions
	vtkImplicitPlaneRepresentation ()

	~vtkImplicitPlaneRepresentation ()

void	HighlightOutline (int highlight)

void	HighlightPlane (int highlight)

void	HighlightNormal (int highlight)

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

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

void	TranslatePlane (double p1, double p2)

void	TranslateOutline (double p1, double p2)

void	TranslateOrigin (double p1, double p2)

void	Push (double p1, double p2)

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

void	SizeHandles ()

void	CreateDefaultProperties ()

void	GeneratePlane ()

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation ()

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

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

virtual void	PickersModified ()
	Update the pickers registered in the Picking Manager when pickers are modified. More...

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

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

double	SizeHandlesRelativeToViewport (double factor, double pos[3])

double	SizeHandlesInPixels (double factor, double pos[3])

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp ()

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=NULL)
	These methods allow a command to exclusively grab all events. More...

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

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]

int	NormalToXAxis

int	NormalToYAxis

int	NormalToZAxis

int	LockNormalToCamera

double	BumpDistance

vtkPlane *	Plane

vtkImageData *	Box

vtkOutlineFilter *	Outline

vtkPolyDataMapper *	OutlineMapper

vtkActor *	OutlineActor

int	OutlineTranslation

int	ScaleEnabled

int	OutsideBounds

double	WidgetBounds [6]

int	ConstrainToWidgetBounds

vtkCutter *	Cutter

vtkPolyDataMapper *	CutMapper

vtkActor *	CutActor

int	DrawPlane

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

vtkTransform *	Transform

vtkProperty *	NormalProperty

vtkProperty *	SelectedNormalProperty

vtkProperty *	PlaneProperty

vtkProperty *	SelectedPlaneProperty

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
	Standard methods for the class. More...

static int	IsTypeOf (const char *type)
	Standard methods for the class. More...

static vtkImplicitPlaneRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for the class. More...

virtual int	IsA (const char *type)
	Standard methods for the class. More...

vtkImplicitPlaneRepresentation *	NewInstance () const
	Standard methods for the class. More...

void	PrintSelf (ostream &os, vtkIndent indent)
	Standard methods for the class. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for the class. More...

Detailed Description

a class defining the representation for a vtkImplicitPlaneWidget2

This class is a concrete representation for the vtkImplicitPlaneWidget2. It represents an infinite plane defined by a normal and point in the context of a bounding box. Through interaction with the widget, the plane can be manipulated by adjusting the plane normal or moving the origin point.

To use this representation, you normally define a (plane) origin and (plane) normal. The PlaceWidget() method is also used to initially position the representation.

Warning: This class, and vtkImplicitPlaneWidget2, are next generation VTK widgets. An earlier version of this functionality was defined in the class vtkImplicitPlaneWidget.

See also: vtkImplicitPlaneWidget2 vtkImplicitPlaneWidget

Tests:: vtkImplicitPlaneRepresentation (Tests)

Definition at line 66 of file vtkImplicitPlaneRepresentation.h.

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkImplicitPlaneRepresentation::Superclass

Standard methods for the class.

Definition at line 78 of file vtkImplicitPlaneRepresentation.h.

Member Enumeration Documentation

enum vtkImplicitPlaneRepresentation::_InteractionState

Enumerator
Outside
Moving
MovingOutline
MovingOrigin
Rotating
Pushing
Scaling

Definition at line 335 of file vtkImplicitPlaneRepresentation.h.

Constructor & Destructor Documentation

vtkImplicitPlaneRepresentation::vtkImplicitPlaneRepresentation ( )

protected

vtkImplicitPlaneRepresentation::~vtkImplicitPlaneRepresentation ( )

protected

Member Function Documentation

static vtkImplicitPlaneRepresentation* vtkImplicitPlaneRepresentation::New ( )

static

Instantiate the class.

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

static

Standard methods for the class.

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

virtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

static

Standard methods for the class.

virtual vtkObjectBase* vtkImplicitPlaneRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

vtkImplicitPlaneRepresentation* vtkImplicitPlaneRepresentation::NewInstance ( ) const

Standard methods for the class.

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

virtual

Standard methods for the class.

Reimplemented from vtkObject.

void vtkImplicitPlaneRepresentation::SetOrigin	(	double	x,
		double	y,
		double	z
	)

Get the origin of the plane.

void vtkImplicitPlaneRepresentation::SetOrigin ( double x[3] )

Get the origin of the plane.

double* vtkImplicitPlaneRepresentation::GetOrigin ( )

Get the origin of the plane.

void vtkImplicitPlaneRepresentation::GetOrigin ( double xyz[3] )

Get the origin of the plane.

void vtkImplicitPlaneRepresentation::SetNormal	(	double	x,
		double	y,
		double	z
	)

Get the normal to the plane.

void vtkImplicitPlaneRepresentation::SetNormal ( double x[3] )

Get the normal to the plane.

void vtkImplicitPlaneRepresentation::SetNormalToCamera ( )

Get the normal to the plane.

double* vtkImplicitPlaneRepresentation::GetNormal ( )

Get the normal to the plane.

void vtkImplicitPlaneRepresentation::GetNormal ( double xyz[3] )

Get the normal to the plane.

void vtkImplicitPlaneRepresentation::SetNormalToXAxis ( int )

Force the plane widget to be aligned with one of the x-y-z axes.