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

#include <vtkImplicitPlaneRepresentation.h>

Inheritance diagram for vtkImplicitPlaneRepresentation:

Collaboration diagram for vtkImplicitPlaneRepresentation:

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

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

Public Types inherited from vtkWidgetRepresentation
enum	Axis { NONE = -1 , XAxis = 0 , YAxis = 1 , ZAxis = 2 , Custom = 3 }
	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	GetPolyData (vtkPolyData *pd)
	Grab the polydata that defines the plane.

vtkPolyDataAlgorithm *	GetPolyDataAlgorithm ()
	Satisfies superclass API.

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.

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

void	UpdatePlacement ()
	Satisfies the superclass API.

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

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

vtkPlane *	GetUnderlyingPlane ()


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

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

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

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


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

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

void	SetNormalToCamera ()
	Get the normal to the plane.

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

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


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

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

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

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

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

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

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

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

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

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

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

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


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

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

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.

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.


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

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

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

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


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

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

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

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


void	SetDrawOutline (vtkTypeBool plane)
	Enable/disable the drawing of the outline.

virtual vtkTypeBool	GetDrawOutline ()
	Enable/disable the drawing of the outline.

virtual void	DrawOutlineOn ()
	Enable/disable the drawing of the outline.

virtual void	DrawOutlineOff ()
	Enable/disable the drawing of the outline.


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

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

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

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


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

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


virtual vtkProperty *	GetPlaneProperty ()
	Get the plane properties.

virtual vtkProperty *	GetSelectedPlaneProperty ()
	Get the plane properties.


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


void	SetInteractionColor (double, double, double)
	Set the color of all the widget's handles (edges, cone1, cone2, line, sphere, selected plane) and their color during interaction.

void	SetInteractionColor (double c[3])
	Set the color of all the widget's handles (edges, cone1, cone2, line, sphere, selected plane) and their color during interaction.

void	SetHandleColor (double, double, double)
	Set the color of all the widget's handles (edges, cone1, cone2, line, sphere, selected plane) and their color during interaction.

void	SetHandleColor (double c[3])
	Set the color of all the widget's handles (edges, cone1, cone2, line, sphere, selected plane) and their color during interaction.

void	SetForegroundColor (double, double, double)
	Set the color of all the widget's handles (edges, cone1, cone2, line, sphere, selected plane) and their color during interaction.

void	SetForegroundColor (double c[3])
	Set the color of all the widget's handles (edges, cone1, cone2, line, sphere, selected plane) and their color during interaction.


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

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

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


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

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


int	ComputeInteractionState (int X, int Y, int modify=0) override
	Methods to interface with the vtkImplicitPlaneWidget2.

void	PlaceWidget (double bounds[6]) override
	Methods to interface with the vtkImplicitPlaneWidget2.

void	BuildRepresentation () override
	Methods to interface with the vtkImplicitPlaneWidget2.

void	StartWidgetInteraction (double eventPos[2]) override
	Methods to interface with the vtkImplicitPlaneWidget2.

void	WidgetInteraction (double newEventPos[2]) override
	Methods to interface with the vtkImplicitPlaneWidget2.

void	EndWidgetInteraction (double newEventPos[2]) override
	Methods to interface with the vtkImplicitPlaneWidget2.

void	StartComplexInteraction (vtkRenderWindowInteractor iren, vtkAbstractWidget widget, unsigned long event, void *calldata) override
	Methods to interface with the vtkImplicitPlaneWidget2.

void	ComplexInteraction (vtkRenderWindowInteractor iren, vtkAbstractWidget widget, unsigned long event, void *calldata) override
	Methods to interface with the vtkImplicitPlaneWidget2.

int	ComputeComplexInteractionState (vtkRenderWindowInteractor iren, vtkAbstractWidget widget, unsigned long event, void *calldata, int modify=0) override
	Methods to interface with the vtkImplicitPlaneWidget2.

void	EndComplexInteraction (vtkRenderWindowInteractor iren, vtkAbstractWidget widget, unsigned long event, void *calldata) override
	Methods to interface with the vtkImplicitPlaneWidget2.


double *	GetBounds () override
	Methods supporting the rendering process.

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

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

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

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

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Methods supporting the rendering process.


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


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

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


virtual void	SetCropPlaneToBoundingBox (bool)
	Control if the plane should be drawn cropped by the bounding box or without cropping.

virtual bool	GetCropPlaneToBoundingBox ()
	Control if the plane should be drawn cropped by the bounding box or without cropping.

virtual void	CropPlaneToBoundingBoxOn ()
	Control if the plane should be drawn cropped by the bounding box or without cropping.

virtual void	CropPlaneToBoundingBoxOff ()
	Control if the plane should be drawn cropped by the bounding box or without cropping.


virtual bool	GetSnapToAxes ()
	For complex events should we snap orientations to be aligned with the x y z axes.

virtual void	SetSnapToAxes (bool)
	For complex events should we snap orientations to be aligned with the x y z axes.


virtual bool	GetAlwaysSnapToNearestAxis ()
	Forces the plane's normal to be aligned with x, y or z axis.

virtual void	SetAlwaysSnapToNearestAxis (bool snap)
	Forces the plane's normal to be aligned with x, y or z axis.

Public Member Functions inherited from vtkBoundedWidgetRepresentation
virtual void	SetOutlineTranslation (bool)
	Turn On/Off the ability to translate the bounding box from mouse interaction.

virtual bool	GetOutlineTranslation ()
	Turn On/Off the ability to translate the bounding box from mouse interaction.

virtual void	OutlineTranslationOn ()
	Turn On/Off the ability to translate the bounding box from mouse interaction.

virtual void	OutlineTranslationOff ()
	Turn On/Off the ability to translate the bounding box from mouse interaction.

virtual void	SetOutsideBounds (bool)
	Turn On/Off the ability to move the widget origin outside the bounds defined by the PlaceWidget call.

virtual bool	GetOutsideBounds ()
	Turn On/Off the ability to move the widget origin outside the bounds defined by the PlaceWidget call.

virtual void	OutsideBoundsOn ()
	Turn On/Off the ability to move the widget origin outside the bounds defined by the PlaceWidget call.

virtual void	OutsideBoundsOff ()
	Turn On/Off the ability to move the widget origin outside the bounds defined by the PlaceWidget call.

virtual void	SetConstrainToWidgetBounds (bool)
	Turn On/Off whether the widget origin should be contained in WidgetBounds.

virtual bool	GetConstrainToWidgetBounds ()
	Turn On/Off whether the widget origin should be contained in WidgetBounds.

virtual void	ConstrainToWidgetBoundsOn ()
	Turn On/Off whether the widget origin should be contained in WidgetBounds.

virtual void	ConstrainToWidgetBoundsOff ()
	Turn On/Off whether the widget origin should be contained in WidgetBounds.

virtual vtkProperty *	GetOutlineProperty ()
	Get the outline property.

virtual vtkProperty *	GetSelectedOutlineProperty ()
	Get the outline property.

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

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

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

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

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

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

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

void	SetXTranslationAxisOn ()
	Constrains translation on given axis.

void	SetYTranslationAxisOn ()
	Constrains translation on given axis.

void	SetZTranslationAxisOn ()
	Constrains translation on given axis.

void	SetTranslationAxisOff ()
	Constrains translation on given axis.

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

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

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

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.

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

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

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

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

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

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.

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.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

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

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

static vtkBoundedWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this 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 (vtkTypeBool 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 vtkTypeBool	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
	vtkImplicitPlaneRepresentation ()

	~vtkImplicitPlaneRepresentation () override

void	HighlightPlane (int highlight)

void	HighlightNormal (int highlight)

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

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

void	Rotate3D (double p1, double p2)

void	TranslateRepresentation (const vtkVector3d &) override
	Translate the representation, to be implemented in derived class.

void	TranslateOrigin (double p1, double p2)

void	UpdatePose (double p1, double d1, double p2, double d2)

void	Push (double p1, double p2)

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

void	SizeHandles ()

void	CreateDefaultProperties () override
	Create and initialize properties with default values.

Protected Member Functions inherited from vtkBoundedWidgetRepresentation
	vtkBoundedWidgetRepresentation ()

	~vtkBoundedWidgetRepresentation () override

vtkActor *	GetOutlineActor ()

void	HighlightOutline (int highlight)
	Switch between outline properties depending on highlight.

void	TranslateOutline (double p1, double p2)
	Translate outline from point p1 to point p2.

virtual void	TranslateRepresentation (const vtkVector3d &)
	Translate the representation, to be implemented in derived class.

bool	IsTranslationConstrained ()
	Returns true if Axis is constrained, i.e.

double	GetDiagonalLength ()
	Return the Outline diagonal length.

void	TransformBounds (vtkTransform *transform)
	Transform the current outline bounds using given transform.

void	UpdateCenterAndBounds (double center[6])
	Modify Center argument to clamp it into bounds, if required.

virtual void	CreateDefaultProperties ()
	Create and initialize properties with default values.

void	UpdateOutline ()
	Ensure outline is up to date.

vtkImageData *	GetBox ()

void	SetOutlineBounds (double bounds[6])
	Set/Get the outline bounds.

void	GetOutlineBounds (double bounds[6])
	Set/Get the outline bounds.

void	SetOutlineColor (double r, double g, double b)
	Set the default colors for outline.

void	SetSelectedOutlineColor (double r, double g, double b)
	Set the default colors for outline.

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation () override

vtkVector3d	GetWorldPoint (vtkAbstractPicker *picker, double screenPos[2])
	Return the given screen point in world coordinates, based on picked position.

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

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	RepresentationState

double	LastEventPosition [3]

double	LastEventOrientation [4]

double	StartEventOrientation [4]

vtkTypeBool	NormalToXAxis

vtkTypeBool	NormalToYAxis

vtkTypeBool	NormalToZAxis

double	SnappedEventOrientation [4]

bool	SnappedOrientation

bool	SnapToAxes

bool	AlwaysSnapToNearestAxis

vtkTypeBool	LockNormalToCamera

double	BumpDistance

vtkPlane *	Plane

vtkTypeBool	ScaleEnabled

vtkCutter *	Cutter

vtkPlaneSource *	PlaneSource

vtkPolyDataMapper *	CutMapper

vtkActor *	CutActor

vtkTypeBool	DrawPlane

vtkTypeBool	DrawOutline

vtkFeatureEdges *	Edges

vtkTubeFilter *	EdgesTuber

vtkPolyDataMapper *	EdgesMapper

vtkActor *	EdgesActor

vtkTypeBool	Tubing

vtkConeSource *	ConeSource

vtkPolyDataMapper *	ConeMapper

vtkActor *	ConeActor

vtkLineSource *	LineSource

vtkPolyDataMapper *	LineMapper

vtkActor *	LineActor

vtkConeSource *	ConeSource2

vtkPolyDataMapper *	ConeMapper2

vtkActor *	ConeActor2

vtkSphereSource *	Sphere

vtkPolyDataMapper *	SphereMapper

vtkActor *	SphereActor

vtkCellPicker *	Picker

vtkTransform *	Transform

vtkProperty *	NormalProperty

vtkProperty *	SelectedNormalProperty

vtkProperty *	PlaneProperty

vtkProperty *	SelectedPlaneProperty

vtkProperty *	OutlineProperty

vtkProperty *	SelectedOutlineProperty

vtkProperty *	EdgesProperty

bool	CropPlaneToBoundingBox

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

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

std::string	ObjectName

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

vtkWeakPointerBase **	WeakPointers

typedef vtkBoundedWidgetRepresentation	Superclass
	Standard methods for the class.

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

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

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

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

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

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for 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 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 vtkImplicitImageRepresentation

Examples:: vtkImplicitPlaneRepresentation (Examples)

Online Examples:

ImplicitPlaneWidget2

Tests:: vtkImplicitPlaneRepresentation (Tests)

Definition at line 79 of file vtkImplicitPlaneRepresentation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkBoundedWidgetRepresentation vtkImplicitPlaneRepresentation::Superclass

Standard methods for the class.

Definition at line 92 of file vtkImplicitPlaneRepresentation.h.

Member Enumeration Documentation

◆ InteractionStateType

enum vtkImplicitPlaneRepresentation::InteractionStateType

Enumerator
Outside
Moving
MovingOutline
MovingOrigin
Rotating
Pushing
Scaling

Definition at line 332 of file vtkImplicitPlaneRepresentation.h.

Constructor & Destructor Documentation

◆ vtkImplicitPlaneRepresentation()

vtkImplicitPlaneRepresentation::vtkImplicitPlaneRepresentation ( )

protected

◆ ~vtkImplicitPlaneRepresentation()

vtkImplicitPlaneRepresentation::~vtkImplicitPlaneRepresentation ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkImplicitPlaneRepresentation * vtkImplicitPlaneRepresentation::New ( )

static

Instantiate the class.

◆ IsTypeOf()

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

static

Standard methods for the class.

◆ IsA()

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

virtual

Standard methods for the class.

Reimplemented from vtkBoundedWidgetRepresentation.

Reimplemented in vtkImplicitImageRepresentation.

◆ SafeDownCast()

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

static

Standard methods for the class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkImplicitPlaneRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for the class.

Reimplemented from vtkBoundedWidgetRepresentation.

Reimplemented in vtkImplicitImageRepresentation.

◆ NewInstance()

vtkImplicitPlaneRepresentation * vtkImplicitPlaneRepresentation::NewInstance ( ) const

Standard methods for the class.

◆ PrintSelf()

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

overridevirtual

Standard methods for the class.

Reimplemented from vtkBoundedWidgetRepresentation.

◆ SetOrigin() [1/2]

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

Get the origin of the plane.

◆ SetOrigin() [2/2]

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

Get the origin of the plane.

◆ GetOrigin() [1/2]

double * vtkImplicitPlaneRepresentation::GetOrigin ( )

Get the origin of the plane.

◆ GetOrigin() [2/2]

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

Get the origin of the plane.

◆ SetNormal() [1/2]

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

Get the normal to the plane.

◆ SetNormal() [2/2]

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

Get the normal to the plane.

◆ SetNormalToCamera()

void vtkImplicitPlaneRepresentation::SetNormalToCamera ( )

Get the normal to the plane.

◆ GetNormal() [1/2]

double * vtkImplicitPlaneRepresentation::GetNormal ( )

Get the normal to the plane.

◆ GetNormal() [2/2]

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

Get the normal to the plane.