VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImplicitPlaneRepresentation Class Reference

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

#include <vtkImplicitPlaneRepresentation.h>

Inheritance diagram for vtkImplicitPlaneRepresentation:
[legend]
Collaboration diagram for vtkImplicitPlaneRepresentation:
[legend]

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...
 
vtkPolyDataAlgorithmGetPolyDataAlgorithm ()
 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...
 
vtkPlaneGetUnderlyingPlane ()
 
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...
 
doubleGetOrigin ()
 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...
 
doubleGetNormal ()
 Get the normal to the plane. More...
 
void GetNormal (double xyz[3])
 Get the normal to the plane. More...
 
void SetNormalToXAxis (vtkTypeBool)
 Force the plane widget to be aligned with one of the x-y-z axes. More...
 
virtual vtkTypeBool 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 (vtkTypeBool)
 Force the plane widget to be aligned with one of the x-y-z axes. More...
 
virtual vtkTypeBool 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 (vtkTypeBool)
 Force the plane widget to be aligned with one of the x-y-z axes. More...
 
virtual vtkTypeBool 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 (vtkTypeBool)
 If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal. More...
 
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. 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 (vtkTypeBool)
 Turn on/off tubing of the wire outline of the plane. More...
 
virtual vtkTypeBool 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 (vtkTypeBool plane)
 Enable/disable the drawing of the plane. More...
 
virtual vtkTypeBool 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...
 
void SetDrawOutline (vtkTypeBool plane)
 Enable/disable the drawing of the outline. More...
 
virtual vtkTypeBool GetDrawOutline ()
 Enable/disable the drawing of the outline. More...
 
virtual void DrawOutlineOn ()
 Enable/disable the drawing of the outline. More...
 
virtual void DrawOutlineOff ()
 Enable/disable the drawing of the outline. More...
 
virtual void SetOutlineTranslation (vtkTypeBool)
 Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button. More...
 
virtual vtkTypeBool 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 (vtkTypeBool)
 Turn on/off the ability to move the widget outside of the bounds specified in the initial PlaceWidget() invocation. More...
 
virtual vtkTypeBool 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 doubleGetWidgetBounds ()
 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 (vtkTypeBool)
 Turn on/off whether the plane should be constrained to the widget bounds. More...
 
virtual vtkTypeBool 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 (vtkTypeBool)
 Turn on/off the ability to scale the widget with the mouse. More...
 
virtual vtkTypeBool 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 vtkPropertyGetNormalProperty ()
 Get the properties on the normal (line and cone). More...
 
virtual vtkPropertyGetSelectedNormalProperty ()
 Get the properties on the normal (line and cone). More...
 
virtual vtkPropertyGetPlaneProperty ()
 Get the plane properties. More...
 
virtual vtkPropertyGetSelectedPlaneProperty ()
 Get the plane properties. More...
 
virtual vtkPropertyGetOutlineProperty ()
 Get the property of the outline. More...
 
virtual vtkPropertyGetSelectedOutlineProperty ()
 Get the property of the outline. More...
 
virtual vtkPropertyGetEdgesProperty ()
 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...
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 Methods to interface with the vtkImplicitPlaneWidget2. More...
 
void PlaceWidget (double bounds[6]) override
 Methods to interface with the vtkImplicitPlaneWidget2. More...
 
void BuildRepresentation () override
 Methods to interface with the vtkImplicitPlaneWidget2. More...
 
void StartWidgetInteraction (double eventPos[2]) override
 Methods to interface with the vtkImplicitPlaneWidget2. More...
 
void WidgetInteraction (double newEventPos[2]) override
 Methods to interface with the vtkImplicitPlaneWidget2. More...
 
void EndWidgetInteraction (double newEventPos[2]) override
 Methods to interface with the vtkImplicitPlaneWidget2. More...
 
void StartComplexInteraction (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) override
 Methods to interface with the vtkImplicitPlaneWidget2. More...
 
void ComplexInteraction (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) override
 Methods to interface with the vtkImplicitPlaneWidget2. More...
 
int ComputeComplexInteractionState (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata, int modify=0) override
 Methods to interface with the vtkImplicitPlaneWidget2. More...
 
void EndComplexInteraction (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) override
 Methods to interface with the vtkImplicitPlaneWidget2. More...
 
doubleGetBounds () override
 Methods supporting the rendering process. More...
 
void GetActors (vtkPropCollection *pc) override
 Methods supporting the rendering process. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Methods supporting the rendering process. More...
 
int RenderOpaqueGeometry (vtkViewport *) override
 Methods supporting the rendering process. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *) override
 Methods supporting the rendering process. More...
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 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...
 
virtual void SetCropPlaneToBoundingBox (bool)
 Control if the plane should be drawn cropped by the bounding box or without cropping. More...
 
virtual bool GetCropPlaneToBoundingBox ()
 Control if the plane should be drawn cropped by the bounding box or without cropping. More...
 
virtual void CropPlaneToBoundingBoxOn ()
 Control if the plane should be drawn cropped by the bounding box or without cropping. More...
 
virtual void CropPlaneToBoundingBoxOff ()
 Control if the plane should be drawn cropped by the bounding box or without cropping. More...
 
virtual bool GetSnapToAxes ()
 For complex events should we snap orientations to be aligned with the x y z axes. More...
 
virtual void SetSnapToAxes (bool)
 For complex events should we snap orientations to be aligned with the x y z axes. 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))
 
doubleGetBounds () override
 Methods to make this class behave as a vtkProp. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp. More...
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
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. More...
 
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. More...
 
virtual void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
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...
 
void SetPickingManaged (bool managed)
 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 vtkRendererGetRenderer ()
 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 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). More...
 
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). 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...
 
vtkWidgetRepresentationNewInstance () const
 Standard methods for instances of this class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instances of this class. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 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 vtkMatrix4x4GetMatrix ()
 
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 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. 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 ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool 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 (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool 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 (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool 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 vtkAssemblyPathGetNextPath ()
 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 vtkInformationGetPropertyKeys ()
 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...
 
vtkObjectGetConsumer (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...
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property. More...
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- 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 ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. 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...
 
vtkCommandGetCommand (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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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 vtkImplicitPlaneRepresentationNew ()
 Instantiate the class. More...
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class. More...
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 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 vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 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 vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

 vtkImplicitPlaneRepresentation ()
 
 ~vtkImplicitPlaneRepresentation () override
 
void HighlightOutline (int highlight)
 
void HighlightPlane (int highlight)
 
void HighlightNormal (int highlight)
 
void RegisterPickers () override
 Register internal Pickers in the Picking Manager. More...
 
void Rotate (double X, double Y, double *p1, double *p2, double *vpn)
 
void Rotate3D (double *p1, double *p2)
 
void TranslatePlane (double *p1, double *p2)
 
void TranslateOutline (double *p1, double *p2)
 
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 ()
 
void GeneratePlane ()
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation () override
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the widget representation currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (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...
 
vtkAssemblyPathGetAssemblyPath3DPoint (double pos[3], vtkAbstractPropPicker *picker)
 
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
 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. 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]
 
double LastEventOrientation [4]
 
double StartEventOrientation [4]
 
vtkTypeBool NormalToXAxis
 
vtkTypeBool NormalToYAxis
 
vtkTypeBool NormalToZAxis
 
double SnappedEventOrientation [4]
 
bool SnappedOrientation
 
bool SnapToAxes
 
vtkTypeBool LockNormalToCamera
 
double BumpDistance
 
vtkPlanePlane
 
vtkImageDataBox
 
vtkOutlineFilterOutline
 
vtkPolyDataMapperOutlineMapper
 
vtkActorOutlineActor
 
vtkTypeBool OutlineTranslation
 
vtkTypeBool ScaleEnabled
 
vtkTypeBool OutsideBounds
 
double WidgetBounds [6]
 
vtkTypeBool ConstrainToWidgetBounds
 
vtkCutterCutter
 
vtkPlaneSourcePlaneSource
 
vtkPolyDataMapperCutMapper
 
vtkActorCutActor
 
vtkTypeBool DrawPlane
 
vtkTypeBool DrawOutline
 
vtkFeatureEdgesEdges
 
vtkTubeFilterEdgesTuber
 
vtkPolyDataMapperEdgesMapper
 
vtkActorEdgesActor
 
vtkTypeBool Tubing
 
vtkConeSourceConeSource
 
vtkPolyDataMapperConeMapper
 
vtkActorConeActor
 
vtkLineSourceLineSource
 
vtkPolyDataMapperLineMapper
 
vtkActorLineActor
 
vtkConeSourceConeSource2
 
vtkPolyDataMapperConeMapper2
 
vtkActorConeActor2
 
vtkLineSourceLineSource2
 
vtkPolyDataMapperLineMapper2
 
vtkActorLineActor2
 
vtkSphereSourceSphere
 
vtkPolyDataMapperSphereMapper
 
vtkActorSphereActor
 
vtkCellPickerPicker
 
vtkTransformTransform
 
vtkPropertyNormalProperty
 
vtkPropertySelectedNormalProperty
 
vtkPropertyPlaneProperty
 
vtkPropertySelectedPlaneProperty
 
vtkPropertyOutlineProperty
 
vtkPropertySelectedOutlineProperty
 
vtkPropertyEdgesProperty
 
bool CropPlaneToBoundingBox
 
vtkBoxBoundingBox
 
- Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRendererRenderer
 
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< vtkTransformTempTransform
 
vtkNew< vtkMatrix4x4TempMatrix
 
- 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
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- 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 vtkTypeBool IsTypeOf (const char *type)
 Standard methods for the class. More...
 
static vtkImplicitPlaneRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for the class. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for the class. More...
 
vtkImplicitPlaneRepresentationNewInstance () const
 Standard methods for the class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for the class. More...
 
virtual vtkObjectBaseNewInstanceInternal () 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 67 of file vtkImplicitPlaneRepresentation.h.

Member Typedef Documentation

Standard methods for the class.

Definition at line 79 of file vtkImplicitPlaneRepresentation.h.

Member Enumeration Documentation

Enumerator
Outside 
Moving 
MovingOutline 
MovingOrigin 
Rotating 
Pushing 
Scaling 

Definition at line 362 of file vtkImplicitPlaneRepresentation.h.

Constructor & Destructor Documentation

vtkImplicitPlaneRepresentation::vtkImplicitPlaneRepresentation ( )
protected
vtkImplicitPlaneRepresentation::~vtkImplicitPlaneRepresentation ( )
overrideprotected

Member Function Documentation

static vtkImplicitPlaneRepresentation* vtkImplicitPlaneRepresentation::New ( )
static

Instantiate the class.

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

Standard methods for the class.

virtual vtkTypeBool 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 
)
overridevirtual

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

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

If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetNormalToXAxis ( )
virtual

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

If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

virtual void vtkImplicitPlaneRepresentation::NormalToXAxisOn ( )
virtual

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

If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

virtual void vtkImplicitPlaneRepresentation::NormalToXAxisOff ( )
virtual

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

If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

void vtkImplicitPlaneRepresentation::SetNormalToYAxis ( vtkTypeBool  )

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

If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetNormalToYAxis ( )
virtual

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

If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

virtual void vtkImplicitPlaneRepresentation::NormalToYAxisOn ( )
virtual

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

If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

virtual void vtkImplicitPlaneRepresentation::NormalToYAxisOff ( )
virtual

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

If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

void vtkImplicitPlaneRepresentation::SetNormalToZAxis ( vtkTypeBool  )

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

If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetNormalToZAxis ( )
virtual

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

If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

virtual void vtkImplicitPlaneRepresentation::NormalToZAxisOn ( )
virtual

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

If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

virtual void vtkImplicitPlaneRepresentation::NormalToZAxisOff ( )
virtual

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

If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

virtual void vtkImplicitPlaneRepresentation::SetLockNormalToCamera ( vtkTypeBool  )
virtual

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

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetLockNormalToCamera ( )
virtual

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

virtual void vtkImplicitPlaneRepresentation::LockNormalToCameraOn ( )
virtual

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

virtual void vtkImplicitPlaneRepresentation::LockNormalToCameraOff ( )
virtual

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

virtual void vtkImplicitPlaneRepresentation::SetTubing ( vtkTypeBool  )
virtual

Turn on/off tubing of the wire outline of the plane.

The tube thickens the line by wrapping with a vtkTubeFilter.

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetTubing ( )
virtual

Turn on/off tubing of the wire outline of the plane.

The tube thickens the line by wrapping with a vtkTubeFilter.

virtual void vtkImplicitPlaneRepresentation::TubingOn ( )
virtual

Turn on/off tubing of the wire outline of the plane.

The tube thickens the line by wrapping with a vtkTubeFilter.

virtual void vtkImplicitPlaneRepresentation::TubingOff ( )
virtual

Turn on/off tubing of the wire outline of the plane.

The tube thickens the line by wrapping with a vtkTubeFilter.

void vtkImplicitPlaneRepresentation::SetDrawPlane ( vtkTypeBool  plane)

Enable/disable the drawing of the plane.

In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetDrawPlane ( )
virtual

Enable/disable the drawing of the plane.

In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

virtual void vtkImplicitPlaneRepresentation::DrawPlaneOn ( )
virtual

Enable/disable the drawing of the plane.

In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

virtual void vtkImplicitPlaneRepresentation::DrawPlaneOff ( )
virtual

Enable/disable the drawing of the plane.

In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

void vtkImplicitPlaneRepresentation::SetDrawOutline ( vtkTypeBool  plane)

Enable/disable the drawing of the outline.

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetDrawOutline ( )
virtual

Enable/disable the drawing of the outline.

virtual void vtkImplicitPlaneRepresentation::DrawOutlineOn ( )
virtual

Enable/disable the drawing of the outline.

virtual void vtkImplicitPlaneRepresentation::DrawOutlineOff ( )
virtual

Enable/disable the drawing of the outline.

virtual void vtkImplicitPlaneRepresentation::SetOutlineTranslation ( vtkTypeBool  )
virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetOutlineTranslation ( )
virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

virtual void vtkImplicitPlaneRepresentation::OutlineTranslationOn ( )
virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

virtual void vtkImplicitPlaneRepresentation::OutlineTranslationOff ( )
virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

virtual void vtkImplicitPlaneRepresentation::SetOutsideBounds ( vtkTypeBool  )
virtual

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

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetOutsideBounds ( )
virtual

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

virtual void vtkImplicitPlaneRepresentation::OutsideBoundsOn ( )
virtual

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

virtual void vtkImplicitPlaneRepresentation::OutsideBoundsOff ( )
virtual

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

virtual void vtkImplicitPlaneRepresentation::SetWidgetBounds ( double  ,
double  ,
double  ,
double  ,
double  ,
double   
)
virtual

Set/Get the bounds of the widget representation.

PlaceWidget can also be used to set the bounds of the widget but it may also have other effects on the internal state of the representation. Use this function when only the widget bounds are needs to be modified.

virtual void vtkImplicitPlaneRepresentation::SetWidgetBounds ( double  [6])
virtual

Set/Get the bounds of the widget representation.

PlaceWidget can also be used to set the bounds of the widget but it may also have other effects on the internal state of the representation. Use this function when only the widget bounds are needs to be modified.

virtual double* vtkImplicitPlaneRepresentation::GetWidgetBounds ( )
virtual

Set/Get the bounds of the widget representation.

PlaceWidget can also be used to set the bounds of the widget but it may also have other effects on the internal state of the representation. Use this function when only the widget bounds are needs to be modified.

virtual void vtkImplicitPlaneRepresentation::GetWidgetBounds ( double ,
double ,
double ,
double ,
double ,
double  
)
virtual

Set/Get the bounds of the widget representation.

PlaceWidget can also be used to set the bounds of the widget but it may also have other effects on the internal state of the representation. Use this function when only the widget bounds are needs to be modified.

virtual void vtkImplicitPlaneRepresentation::GetWidgetBounds ( double  [6])
virtual

Set/Get the bounds of the widget representation.

PlaceWidget can also be used to set the bounds of the widget but it may also have other effects on the internal state of the representation. Use this function when only the widget bounds are needs to be modified.

virtual void vtkImplicitPlaneRepresentation::SetConstrainToWidgetBounds ( vtkTypeBool  )
virtual

Turn on/off whether the plane should be constrained to the widget bounds.

If on, the origin will not be allowed to move outside the set widget bounds. This is the default behaviour. If off, the origin can be freely moved and the widget outline will change accordingly.

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetConstrainToWidgetBounds ( )
virtual

Turn on/off whether the plane should be constrained to the widget bounds.

If on, the origin will not be allowed to move outside the set widget bounds. This is the default behaviour. If off, the origin can be freely moved and the widget outline will change accordingly.

virtual void vtkImplicitPlaneRepresentation::ConstrainToWidgetBoundsOn ( )
virtual

Turn on/off whether the plane should be constrained to the widget bounds.

If on, the origin will not be allowed to move outside the set widget bounds. This is the default behaviour. If off, the origin can be freely moved and the widget outline will change accordingly.

virtual void vtkImplicitPlaneRepresentation::ConstrainToWidgetBoundsOff ( )
virtual

Turn on/off whether the plane should be constrained to the widget bounds.

If on, the origin will not be allowed to move outside the set widget bounds. This is the default behaviour. If off, the origin can be freely moved and the widget outline will change accordingly.

virtual void vtkImplicitPlaneRepresentation::SetScaleEnabled ( vtkTypeBool  )
virtual

Turn on/off the ability to scale the widget with the mouse.

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetScaleEnabled ( )
virtual

Turn on/off the ability to scale the widget with the mouse.

virtual void vtkImplicitPlaneRepresentation::ScaleEnabledOn ( )
virtual

Turn on/off the ability to scale the widget with the mouse.

virtual void vtkImplicitPlaneRepresentation::ScaleEnabledOff ( )
virtual

Turn on/off the ability to scale the widget with the mouse.

void vtkImplicitPlaneRepresentation::GetPolyData ( vtkPolyData pd)

Grab the polydata that defines the plane.

The polydata contains a single polygon that is clipped by the bounding box.

vtkPolyDataAlgorithm* vtkImplicitPlaneRepresentation::GetPolyDataAlgorithm ( )

Satisfies superclass API.

This returns a pointer to the underlying PolyData (which represents the plane).

void vtkImplicitPlaneRepresentation::GetPlane ( vtkPlane plane)

Get the implicit function for the plane by copying the origin and normal of the cut plane into the provided vtkPlane.

The user must provide the instance of the class vtkPlane. Note that vtkPlane is a subclass of vtkImplicitFunction, meaning that it can be used by a variety of filters to perform clipping, cutting, and selection of data.

void vtkImplicitPlaneRepresentation::SetPlane ( vtkPlane plane)

Alternative way to define the cutting plane.

The normal and origin of the plane provided is copied into the internal instance of the class cutting vtkPlane.

void vtkImplicitPlaneRepresentation::UpdatePlacement ( void  )

Satisfies the superclass API.

This will change the state of the widget to match changes that have been made to the underlying PolyDataSource

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetNormalProperty ( )
virtual

Get the properties on the normal (line and cone).

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetSelectedNormalProperty ( )
virtual

Get the properties on the normal (line and cone).

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetPlaneProperty ( )
virtual

Get the plane properties.

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

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetSelectedPlaneProperty ( )
virtual

Get the plane properties.

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

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetOutlineProperty ( )
virtual

Get the property of the outline.

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetSelectedOutlineProperty ( )
virtual

Get the property of the outline.

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetEdgesProperty ( )
virtual

Get the property of the intersection edges.

(This property also applies to the edges when tubed.)

void vtkImplicitPlaneRepresentation::SetEdgeColor ( vtkLookupTable )

Set color to the edge.

void vtkImplicitPlaneRepresentation::SetEdgeColor ( double  ,
double  ,
double   
)

Set color to the edge.

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

Set color to the edge.

virtual void vtkImplicitPlaneRepresentation::SetBumpDistance ( double  )
virtual

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

Note that the distance is normalized; it is the fraction of the length of the bounding box of the wire outline.

virtual double vtkImplicitPlaneRepresentation::GetBumpDistance ( )
virtual

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

Note that the distance is normalized; it is the fraction of the length of the bounding box of the wire outline.

void vtkImplicitPlaneRepresentation::BumpPlane ( int  dir,
double  factor 
)

Translate the plane in the direction of the normal by the specified BumpDistance.

The dir parameter controls which direction the pushing occurs, either in the same direction as the normal, or when negative, in the opposite direction. The factor controls whether what percentage of the bump is used.

void vtkImplicitPlaneRepresentation::PushPlane ( double  distance)

Push the plane the distance specified along the normal.

Positive values are in the direction of the normal; negative values are in the opposite direction of the normal. The distance value is expressed in world coordinates.

int vtkImplicitPlaneRepresentation::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
)
overridevirtual

Methods to interface with the vtkImplicitPlaneWidget2.

Reimplemented from vtkWidgetRepresentation.

void vtkImplicitPlaneRepresentation::PlaceWidget ( double  bounds[6])
override

Methods to interface with the vtkImplicitPlaneWidget2.

void vtkImplicitPlaneRepresentation::BuildRepresentation ( )
overridevirtual

Methods to interface with the vtkImplicitPlaneWidget2.

Implements vtkWidgetRepresentation.

void vtkImplicitPlaneRepresentation::StartWidgetInteraction ( double  eventPos[2])
overridevirtual

Methods to interface with the vtkImplicitPlaneWidget2.

Reimplemented from vtkWidgetRepresentation.

void vtkImplicitPlaneRepresentation::WidgetInteraction ( double  newEventPos[2])
overridevirtual

Methods to interface with the vtkImplicitPlaneWidget2.

Reimplemented from vtkWidgetRepresentation.

void vtkImplicitPlaneRepresentation::EndWidgetInteraction ( double  newEventPos[2])
overridevirtual

Methods to interface with the vtkImplicitPlaneWidget2.

Reimplemented from vtkWidgetRepresentation.

void vtkImplicitPlaneRepresentation::StartComplexInteraction ( vtkRenderWindowInteractor iren,
vtkAbstractWidget widget,
unsigned long  event,
void *  calldata 
)
overridevirtual

Methods to interface with the vtkImplicitPlaneWidget2.

Reimplemented from vtkWidgetRepresentation.

void vtkImplicitPlaneRepresentation::ComplexInteraction ( vtkRenderWindowInteractor iren,
vtkAbstractWidget widget,
unsigned long  event,
void *  calldata 
)
overridevirtual

Methods to interface with the vtkImplicitPlaneWidget2.

Reimplemented from vtkWidgetRepresentation.

int vtkImplicitPlaneRepresentation::ComputeComplexInteractionState ( vtkRenderWindowInteractor iren,
vtkAbstractWidget widget,
unsigned long  event,
void *  calldata,
int  modify = 0 
)
overridevirtual

Methods to interface with the vtkImplicitPlaneWidget2.

Reimplemented from vtkWidgetRepresentation.

void vtkImplicitPlaneRepresentation::EndComplexInteraction ( vtkRenderWindowInteractor iren,
vtkAbstractWidget widget,
unsigned long  event,
void *  calldata 
)
overridevirtual

Methods to interface with the vtkImplicitPlaneWidget2.

Reimplemented from vtkWidgetRepresentation.

double* vtkImplicitPlaneRepresentation::GetBounds ( )
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

void vtkImplicitPlaneRepresentation::GetActors ( vtkPropCollection pc)
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

void vtkImplicitPlaneRepresentation::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

int vtkImplicitPlaneRepresentation::RenderOpaqueGeometry ( vtkViewport )
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

int vtkImplicitPlaneRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport )
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

vtkTypeBool vtkImplicitPlaneRepresentation::HasTranslucentPolygonalGeometry ( )
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

virtual void vtkImplicitPlaneRepresentation::SetInteractionState ( int  )
virtual

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

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

virtual void vtkImplicitPlaneRepresentation::SetRepresentationState ( int  )
virtual

Sets the visual appearance of the representation based on the state it is in.

This state is usually the same as InteractionState.

virtual int vtkImplicitPlaneRepresentation::GetRepresentationState ( )
virtual

Sets the visual appearance of the representation based on the state it is in.

This state is usually the same as InteractionState.

vtkPlane* vtkImplicitPlaneRepresentation::GetUnderlyingPlane ( )
inline

Definition at line 397 of file vtkImplicitPlaneRepresentation.h.

virtual void vtkImplicitPlaneRepresentation::SetCropPlaneToBoundingBox ( bool  )
virtual

Control if the plane should be drawn cropped by the bounding box or without cropping.

Defaults to on.

virtual bool vtkImplicitPlaneRepresentation::GetCropPlaneToBoundingBox ( )
virtual

Control if the plane should be drawn cropped by the bounding box or without cropping.

Defaults to on.

virtual void vtkImplicitPlaneRepresentation::CropPlaneToBoundingBoxOn ( )
virtual

Control if the plane should be drawn cropped by the bounding box or without cropping.

Defaults to on.

virtual void vtkImplicitPlaneRepresentation::CropPlaneToBoundingBoxOff ( )
virtual

Control if the plane should be drawn cropped by the bounding box or without cropping.

Defaults to on.

virtual bool vtkImplicitPlaneRepresentation::GetSnapToAxes ( )
virtual

For complex events should we snap orientations to be aligned with the x y z axes.

virtual void vtkImplicitPlaneRepresentation::SetSnapToAxes ( bool  )
virtual

For complex events should we snap orientations to be aligned with the x y z axes.

void vtkImplicitPlaneRepresentation::HighlightOutline ( int  highlight)
protected
void vtkImplicitPlaneRepresentation::HighlightPlane ( int  highlight)
protected
void vtkImplicitPlaneRepresentation::HighlightNormal ( int  highlight)
protected
void vtkImplicitPlaneRepresentation::RegisterPickers ( )
overrideprotectedvirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widget representations to register their pickers.

Reimplemented from vtkWidgetRepresentation.

void vtkImplicitPlaneRepresentation::Rotate ( double  X,
double  Y,
double p1,
double p2,
double vpn 
)
protected
void vtkImplicitPlaneRepresentation::Rotate3D ( double p1,
double p2 
)
protected
void vtkImplicitPlaneRepresentation::TranslatePlane ( double p1,
double p2 
)
protected
void vtkImplicitPlaneRepresentation::TranslateOutline ( double p1,
double p2 
)
protected
void vtkImplicitPlaneRepresentation::TranslateOrigin ( double p1,
double p2 
)
protected
void vtkImplicitPlaneRepresentation::UpdatePose ( double p1,
double d1,
double p2,
double d2 
)
protected
void vtkImplicitPlaneRepresentation::Push ( double p1,
double p2 
)
protected
void vtkImplicitPlaneRepresentation::Scale ( double p1,
double p2,
double  X,
double  Y 
)
protected
void vtkImplicitPlaneRepresentation::SizeHandles ( )
protected
void vtkImplicitPlaneRepresentation::CreateDefaultProperties ( )
protected
void vtkImplicitPlaneRepresentation::GeneratePlane ( )
protected

Member Data Documentation

int vtkImplicitPlaneRepresentation::RepresentationState
protected

Definition at line 423 of file vtkImplicitPlaneRepresentation.h.

double vtkImplicitPlaneRepresentation::LastEventPosition[3]
protected

Definition at line 426 of file vtkImplicitPlaneRepresentation.h.

double vtkImplicitPlaneRepresentation::LastEventOrientation[4]
protected

Definition at line 427 of file vtkImplicitPlaneRepresentation.h.

double vtkImplicitPlaneRepresentation::StartEventOrientation[4]
protected

Definition at line 428 of file vtkImplicitPlaneRepresentation.h.

vtkTypeBool vtkImplicitPlaneRepresentation::NormalToXAxis
protected

Definition at line 431 of file vtkImplicitPlaneRepresentation.h.

vtkTypeBool vtkImplicitPlaneRepresentation::NormalToYAxis
protected

Definition at line 432 of file vtkImplicitPlaneRepresentation.h.

vtkTypeBool vtkImplicitPlaneRepresentation::NormalToZAxis
protected

Definition at line 433 of file vtkImplicitPlaneRepresentation.h.

double vtkImplicitPlaneRepresentation::SnappedEventOrientation[4]
protected

Definition at line 435 of file vtkImplicitPlaneRepresentation.h.

bool vtkImplicitPlaneRepresentation::SnappedOrientation
protected

Definition at line 436 of file vtkImplicitPlaneRepresentation.h.

bool vtkImplicitPlaneRepresentation::SnapToAxes
protected

Definition at line 437 of file vtkImplicitPlaneRepresentation.h.

vtkTypeBool vtkImplicitPlaneRepresentation::LockNormalToCamera
protected

Definition at line 440 of file vtkImplicitPlaneRepresentation.h.

double vtkImplicitPlaneRepresentation::BumpDistance
protected

Definition at line 443 of file vtkImplicitPlaneRepresentation.h.

vtkPlane* vtkImplicitPlaneRepresentation::Plane
protected

Definition at line 446 of file vtkImplicitPlaneRepresentation.h.

vtkImageData* vtkImplicitPlaneRepresentation::Box
protected

Definition at line 449 of file vtkImplicitPlaneRepresentation.h.

vtkOutlineFilter* vtkImplicitPlaneRepresentation::Outline
protected

Definition at line 450 of file vtkImplicitPlaneRepresentation.h.

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::OutlineMapper
protected

Definition at line 451 of file vtkImplicitPlaneRepresentation.h.

vtkActor* vtkImplicitPlaneRepresentation::OutlineActor
protected

Definition at line 452 of file vtkImplicitPlaneRepresentation.h.

vtkTypeBool vtkImplicitPlaneRepresentation::OutlineTranslation
protected

Definition at line 454 of file vtkImplicitPlaneRepresentation.h.

vtkTypeBool vtkImplicitPlaneRepresentation::ScaleEnabled
protected

Definition at line 455 of file vtkImplicitPlaneRepresentation.h.

vtkTypeBool vtkImplicitPlaneRepresentation::OutsideBounds
protected

Definition at line 456 of file vtkImplicitPlaneRepresentation.h.

double vtkImplicitPlaneRepresentation::WidgetBounds[6]
protected

Definition at line 457 of file vtkImplicitPlaneRepresentation.h.

vtkTypeBool vtkImplicitPlaneRepresentation::ConstrainToWidgetBounds
protected

Definition at line 458 of file vtkImplicitPlaneRepresentation.h.

vtkCutter* vtkImplicitPlaneRepresentation::Cutter
protected

Definition at line 461 of file vtkImplicitPlaneRepresentation.h.

vtkPlaneSource* vtkImplicitPlaneRepresentation::PlaneSource
protected

Definition at line 462 of file vtkImplicitPlaneRepresentation.h.

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::CutMapper
protected

Definition at line 463 of file vtkImplicitPlaneRepresentation.h.

vtkActor* vtkImplicitPlaneRepresentation::CutActor
protected

Definition at line 464 of file vtkImplicitPlaneRepresentation.h.

vtkTypeBool vtkImplicitPlaneRepresentation::DrawPlane
protected

Definition at line 465 of file vtkImplicitPlaneRepresentation.h.

vtkTypeBool vtkImplicitPlaneRepresentation::DrawOutline
protected

Definition at line 466 of file vtkImplicitPlaneRepresentation.h.

vtkFeatureEdges* vtkImplicitPlaneRepresentation::Edges
protected

Definition at line 470 of file vtkImplicitPlaneRepresentation.h.

vtkTubeFilter* vtkImplicitPlaneRepresentation::EdgesTuber
protected

Definition at line 471 of file vtkImplicitPlaneRepresentation.h.

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::EdgesMapper
protected

Definition at line 472 of file vtkImplicitPlaneRepresentation.h.

vtkActor* vtkImplicitPlaneRepresentation::EdgesActor
protected

Definition at line 473 of file vtkImplicitPlaneRepresentation.h.

vtkTypeBool vtkImplicitPlaneRepresentation::Tubing
protected

Definition at line 474 of file vtkImplicitPlaneRepresentation.h.

vtkConeSource* vtkImplicitPlaneRepresentation::ConeSource
protected

Definition at line 477 of file vtkImplicitPlaneRepresentation.h.

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::ConeMapper
protected

Definition at line 478 of file vtkImplicitPlaneRepresentation.h.

vtkActor* vtkImplicitPlaneRepresentation::ConeActor
protected

Definition at line 479 of file vtkImplicitPlaneRepresentation.h.

vtkLineSource* vtkImplicitPlaneRepresentation::LineSource
protected

Definition at line 483 of file vtkImplicitPlaneRepresentation.h.

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::LineMapper
protected

Definition at line 484 of file vtkImplicitPlaneRepresentation.h.

vtkActor* vtkImplicitPlaneRepresentation::LineActor
protected

Definition at line 485 of file vtkImplicitPlaneRepresentation.h.

vtkConeSource* vtkImplicitPlaneRepresentation::ConeSource2
protected

Definition at line 488 of file vtkImplicitPlaneRepresentation.h.

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::ConeMapper2
protected

Definition at line 489 of file vtkImplicitPlaneRepresentation.h.

vtkActor* vtkImplicitPlaneRepresentation::ConeActor2
protected

Definition at line 490 of file vtkImplicitPlaneRepresentation.h.

vtkLineSource* vtkImplicitPlaneRepresentation::LineSource2
protected

Definition at line 493 of file vtkImplicitPlaneRepresentation.h.

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::LineMapper2
protected

Definition at line 494 of file vtkImplicitPlaneRepresentation.h.

vtkActor* vtkImplicitPlaneRepresentation::LineActor2
protected

Definition at line 495 of file vtkImplicitPlaneRepresentation.h.

vtkSphereSource* vtkImplicitPlaneRepresentation::Sphere
protected

Definition at line 498 of file vtkImplicitPlaneRepresentation.h.

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::SphereMapper
protected

Definition at line 499 of file vtkImplicitPlaneRepresentation.h.

vtkActor* vtkImplicitPlaneRepresentation::SphereActor
protected

Definition at line 500 of file vtkImplicitPlaneRepresentation.h.

vtkCellPicker* vtkImplicitPlaneRepresentation::Picker
protected

Definition at line 503 of file vtkImplicitPlaneRepresentation.h.

vtkTransform* vtkImplicitPlaneRepresentation::Transform
protected

Definition at line 509 of file vtkImplicitPlaneRepresentation.h.

vtkProperty* vtkImplicitPlaneRepresentation::NormalProperty
protected

Definition at line 524 of file vtkImplicitPlaneRepresentation.h.

vtkProperty* vtkImplicitPlaneRepresentation::SelectedNormalProperty
protected

Definition at line 525 of file vtkImplicitPlaneRepresentation.h.

vtkProperty* vtkImplicitPlaneRepresentation::PlaneProperty
protected

Definition at line 526 of file vtkImplicitPlaneRepresentation.h.

vtkProperty* vtkImplicitPlaneRepresentation::SelectedPlaneProperty
protected

Definition at line 527 of file vtkImplicitPlaneRepresentation.h.

vtkProperty* vtkImplicitPlaneRepresentation::OutlineProperty
protected

Definition at line 528 of file vtkImplicitPlaneRepresentation.h.

vtkProperty* vtkImplicitPlaneRepresentation::SelectedOutlineProperty
protected

Definition at line 529 of file vtkImplicitPlaneRepresentation.h.

vtkProperty* vtkImplicitPlaneRepresentation::EdgesProperty
protected

Definition at line 530 of file vtkImplicitPlaneRepresentation.h.

bool vtkImplicitPlaneRepresentation::CropPlaneToBoundingBox
protected

Definition at line 535 of file vtkImplicitPlaneRepresentation.h.

vtkBox* vtkImplicitPlaneRepresentation::BoundingBox
protected

Definition at line 538 of file vtkImplicitPlaneRepresentation.h.


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