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
}
 
typedef vtkWidgetRepresentation Superclass
 Standard methods for the class. More...
 
- Public Types inherited from vtkWidgetRepresentation
enum  Axis { NONE = -1, XAxis = 0, YAxis = 1, ZAxis = 2 }
 Axis labels. More...
 
typedef vtkProp Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImplicitPlaneRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetOrigin (double x, double y, double z)
 Get the origin of the plane. More...
 
void SetOrigin (double x[3])
 
double * GetOrigin ()
 
void GetOrigin (double xyz[3])
 
void SetNormal (double x, double y, double z)
 Get the normal to the plane. More...
 
void SetNormal (double x[3])
 
void SetNormalToCamera ()
 
double * GetNormal ()
 
void GetNormal (double xyz[3])
 
void SetNormalToXAxis (vtkTypeBool)
 Force the plane widget to be aligned with one of the x-y-z axes. More...
 
virtual vtkTypeBool GetNormalToXAxis ()
 
virtual void NormalToXAxisOn ()
 
virtual void NormalToXAxisOff ()
 
void SetNormalToYAxis (vtkTypeBool)
 
virtual vtkTypeBool GetNormalToYAxis ()
 
virtual void NormalToYAxisOn ()
 
virtual void NormalToYAxisOff ()
 
void SetNormalToZAxis (vtkTypeBool)
 
virtual vtkTypeBool GetNormalToZAxis ()
 
virtual void NormalToZAxisOn ()
 
virtual void NormalToZAxisOff ()
 
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 ()
 
virtual void LockNormalToCameraOn ()
 
virtual void LockNormalToCameraOff ()
 
virtual void SetTubing (vtkTypeBool)
 Turn on/off tubing of the wire outline of the plane. More...
 
virtual vtkTypeBool GetTubing ()
 
virtual void TubingOn ()
 
virtual void TubingOff ()
 
void SetDrawPlane (vtkTypeBool plane)
 Enable/disable the drawing of the plane. More...
 
virtual vtkTypeBool GetDrawPlane ()
 
virtual void DrawPlaneOn ()
 
virtual void DrawPlaneOff ()
 
void SetDrawOutline (vtkTypeBool plane)
 Enable/disable the drawing of the outline. More...
 
virtual vtkTypeBool GetDrawOutline ()
 
virtual void DrawOutlineOn ()
 
virtual void DrawOutlineOff ()
 
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 ()
 
virtual void OutlineTranslationOn ()
 
virtual void OutlineTranslationOff ()
 
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 ()
 
virtual void OutsideBoundsOn ()
 
virtual void OutsideBoundsOff ()
 
void SetXTranslationAxisOn ()
 Toggles constraint translation axis on/off. More...
 
void SetYTranslationAxisOn ()
 
void SetZTranslationAxisOn ()
 
void SetTranslationAxisOff ()
 
bool IsTranslationConstrained ()
 Returns true if ContrainedAxis. More...
 
virtual void SetWidgetBounds (double, double, double, double, double, double)
 Set/Get the bounds of the widget representation. More...
 
virtual void SetWidgetBounds (double[6])
 
virtual double * GetWidgetBounds ()
 
virtual void GetWidgetBounds (double &, double &, double &, double &, double &, double &)
 
virtual void GetWidgetBounds (double[6])
 
virtual void SetConstrainToWidgetBounds (vtkTypeBool)
 Turn on/off whether the plane should be constrained to the widget bounds. More...
 
virtual vtkTypeBool GetConstrainToWidgetBounds ()
 
virtual void ConstrainToWidgetBoundsOn ()
 
virtual void ConstrainToWidgetBoundsOff ()
 
virtual void SetScaleEnabled (vtkTypeBool)
 Turn on/off the ability to scale the widget with the mouse. More...
 
virtual vtkTypeBool GetScaleEnabled ()
 
virtual void ScaleEnabledOn ()
 
virtual void ScaleEnabledOff ()
 
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...
 
virtual vtkPropertyGetNormalProperty ()
 Get the properties on the normal (line and cone). More...
 
virtual vtkPropertyGetSelectedNormalProperty ()
 
virtual vtkPropertyGetPlaneProperty ()
 Get the plane properties. More...
 
virtual vtkPropertyGetSelectedPlaneProperty ()
 
virtual vtkPropertyGetOutlineProperty ()
 Get the property of the outline. More...
 
virtual vtkPropertyGetSelectedOutlineProperty ()
 
virtual vtkPropertyGetEdgesProperty ()
 Get the property of the intersection edges. More...
 
void SetEdgeColor (vtkLookupTable *)
 Set color to the edge. More...
 
void SetEdgeColor (double, double, double)
 
void SetEdgeColor (double x[3])
 
virtual void SetBumpDistance (double)
 Specify a translation distance used by the BumpPlane() method. More...
 
virtual double GetBumpDistance ()
 
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...
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 Methods to interface with the vtkImplicitPlaneWidget2. More...
 
void PlaceWidget (double bounds[6]) override
 
void BuildRepresentation () override
 
void StartWidgetInteraction (double eventPos[2]) override
 
void WidgetInteraction (double newEventPos[2]) override
 
void EndWidgetInteraction (double newEventPos[2]) override
 
void StartComplexInteraction (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) override
 
void ComplexInteraction (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) override
 
int ComputeComplexInteractionState (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata, int modify=0) override
 
void EndComplexInteraction (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *calldata) override
 
double * GetBounds () override
 Methods supporting the rendering process. More...
 
void GetActors (vtkPropCollection *pc) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
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 RenderOpaqueGeometry (vtkViewport *) override
 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. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *) 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 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 ()
 
vtkPlaneGetUnderlyingPlane ()
 
virtual void SetCropPlaneToBoundingBox (bool)
 Control if the plane should be drawn cropped by the bounding box or without cropping. More...
 
virtual bool GetCropPlaneToBoundingBox ()
 
virtual void CropPlaneToBoundingBoxOn ()
 
virtual void CropPlaneToBoundingBoxOff ()
 
virtual bool GetSnapToAxes ()
 For complex events should we snap orientations to be aligned with the x y z axes. More...
 
virtual void SetSnapToAxes (bool)
 
virtual bool GetAlwaysSnapToNearestAxis ()
 Forces the plane's normal to be aligned with x, y or z axis. More...
 
virtual void SetAlwaysSnapToNearestAxis (bool snap)
 
- Public Member Functions inherited from vtkWidgetRepresentation
vtkWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 
void SetPickingManaged (bool managed)
 
virtual bool GetPickingManaged ()
 
virtual void SetRenderer (vtkRenderer *ren)
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
virtual vtkRendererGetRenderer ()
 
virtual void PlaceWidget (double *vtkNotUsed(bounds[6]))
 The following is a suggested API for widget representations. More...
 
virtual int GetInteractionState ()
 
virtual void Highlight (int vtkNotUsed(highlightOn))
 
virtual void SetPlaceFactor (double)
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
virtual double GetPlaceFactor ()
 
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 ()
 
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)
 
virtual void NeedToRenderOn ()
 
virtual void NeedToRenderOff ()
 
double * GetBounds () 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...
 
- 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 SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 
virtual void VisibilityOn ()
 
virtual void VisibilityOff ()
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 
virtual void PickableOn ()
 
virtual void PickableOff ()
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 
virtual void DragableOn ()
 
virtual void DragableOff ()
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. 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 ()
 
virtual void UseBoundsOn ()
 
virtual void UseBoundsOff ()
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkAssemblyPathGetNextPath ()
 
virtual int GetNumberOfPaths ()
 
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 vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 
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...
 
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...
 
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 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)
 
vtkObjectGetConsumer (int i)
 
int IsConsumer (vtkObject *c)
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 
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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkImplicitPlaneRepresentationNew ()
 Instantiate the class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImplicitPlaneRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 
- 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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

virtual vtkObjectBaseNewInstanceInternal () const
 
 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)
 
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
 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 ()
 
- 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
 
bool AlwaysSnapToNearestAxis
 
vtkTypeBool LockNormalToCamera
 
double BumpDistance
 
vtkPlanePlane
 
int TranslationAxis
 
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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Definition at line 64 of file vtkImplicitPlaneRepresentation.h.

Member Typedef Documentation

◆ Superclass

Standard methods for the class.

Definition at line 76 of file vtkImplicitPlaneRepresentation.h.

Member Enumeration Documentation

◆ _InteractionState

Enumerator
Outside 
Moving 
MovingOutline 
MovingOrigin 
Rotating 
Pushing 
Scaling 

Definition at line 368 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

◆ IsA()

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

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkWidgetRepresentation.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImplicitPlaneRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkWidgetRepresentation.

◆ NewInstance()

vtkImplicitPlaneRepresentation* vtkImplicitPlaneRepresentation::NewInstance ( ) const

◆ PrintSelf()

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

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

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

◆ GetOrigin() [1/2]

double* vtkImplicitPlaneRepresentation::GetOrigin ( )

◆ GetOrigin() [2/2]

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

◆ 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  x[3])

◆ SetNormalToCamera()

void vtkImplicitPlaneRepresentation::SetNormalToCamera ( )

◆ GetNormal() [1/2]

double* vtkImplicitPlaneRepresentation::GetNormal ( )

◆ GetNormal() [2/2]

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

◆ SetNormalToXAxis()

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.

◆ GetNormalToXAxis()

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetNormalToXAxis ( )
virtual

◆ NormalToXAxisOn()

virtual void vtkImplicitPlaneRepresentation::NormalToXAxisOn ( )
virtual

◆ NormalToXAxisOff()

virtual void vtkImplicitPlaneRepresentation::NormalToXAxisOff ( )
virtual

◆ SetNormalToYAxis()

void vtkImplicitPlaneRepresentation::SetNormalToYAxis ( vtkTypeBool  )

◆ GetNormalToYAxis()

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetNormalToYAxis ( )
virtual

◆ NormalToYAxisOn()

virtual void vtkImplicitPlaneRepresentation::NormalToYAxisOn ( )
virtual

◆ NormalToYAxisOff()

virtual void vtkImplicitPlaneRepresentation::NormalToYAxisOff ( )
virtual

◆ SetNormalToZAxis()

void vtkImplicitPlaneRepresentation::SetNormalToZAxis ( vtkTypeBool  )

◆ GetNormalToZAxis()

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetNormalToZAxis ( )
virtual

◆ NormalToZAxisOn()

virtual void vtkImplicitPlaneRepresentation::NormalToZAxisOn ( )
virtual

◆ NormalToZAxisOff()

virtual void vtkImplicitPlaneRepresentation::NormalToZAxisOff ( )
virtual

◆ SetLockNormalToCamera()

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.

◆ GetLockNormalToCamera()

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetLockNormalToCamera ( )
virtual

◆ LockNormalToCameraOn()

virtual void vtkImplicitPlaneRepresentation::LockNormalToCameraOn ( )
virtual

◆ LockNormalToCameraOff()

virtual void vtkImplicitPlaneRepresentation::LockNormalToCameraOff ( )
virtual

◆ SetTubing()

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.

◆ GetTubing()

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetTubing ( )
virtual

◆ TubingOn()

virtual void vtkImplicitPlaneRepresentation::TubingOn ( )
virtual

◆ TubingOff()

virtual void vtkImplicitPlaneRepresentation::TubingOff ( )
virtual

◆ SetDrawPlane()

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

◆ GetDrawPlane()

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetDrawPlane ( )
virtual

◆ DrawPlaneOn()

virtual void vtkImplicitPlaneRepresentation::DrawPlaneOn ( )
virtual

◆ DrawPlaneOff()

virtual void vtkImplicitPlaneRepresentation::DrawPlaneOff ( )
virtual

◆ SetDrawOutline()

void vtkImplicitPlaneRepresentation::SetDrawOutline ( vtkTypeBool  plane)

Enable/disable the drawing of the outline.

◆ GetDrawOutline()

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetDrawOutline ( )
virtual

◆ DrawOutlineOn()

virtual void vtkImplicitPlaneRepresentation::DrawOutlineOn ( )
virtual

◆ DrawOutlineOff()

virtual void vtkImplicitPlaneRepresentation::DrawOutlineOff ( )
virtual

◆ SetOutlineTranslation()

virtual void vtkImplicitPlaneRepresentation::SetOutlineTranslation ( vtkTypeBool  )
virtual

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

◆ GetOutlineTranslation()

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetOutlineTranslation ( )
virtual

◆ OutlineTranslationOn()

virtual void vtkImplicitPlaneRepresentation::OutlineTranslationOn ( )
virtual

◆ OutlineTranslationOff()

virtual void vtkImplicitPlaneRepresentation::OutlineTranslationOff ( )
virtual

◆ SetOutsideBounds()

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.

◆ GetOutsideBounds()

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetOutsideBounds ( )
virtual

◆ OutsideBoundsOn()

virtual void vtkImplicitPlaneRepresentation::OutsideBoundsOn ( )
virtual

◆ OutsideBoundsOff()

virtual void vtkImplicitPlaneRepresentation::OutsideBoundsOff ( )
virtual

◆ SetXTranslationAxisOn()

void vtkImplicitPlaneRepresentation::SetXTranslationAxisOn ( )
inline

Toggles constraint translation axis on/off.

Definition at line 186 of file vtkImplicitPlaneRepresentation.h.

◆ SetYTranslationAxisOn()

void vtkImplicitPlaneRepresentation::SetYTranslationAxisOn ( )
inline

Definition at line 187 of file vtkImplicitPlaneRepresentation.h.

◆ SetZTranslationAxisOn()

void vtkImplicitPlaneRepresentation::SetZTranslationAxisOn ( )
inline

Definition at line 188 of file vtkImplicitPlaneRepresentation.h.

◆ SetTranslationAxisOff()

void vtkImplicitPlaneRepresentation::SetTranslationAxisOff ( )
inline

Definition at line 189 of file vtkImplicitPlaneRepresentation.h.

◆ IsTranslationConstrained()

bool vtkImplicitPlaneRepresentation::IsTranslationConstrained ( )
inline

Returns true if ContrainedAxis.

Definition at line 196 of file vtkImplicitPlaneRepresentation.h.

◆ SetWidgetBounds() [1/2]

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.

◆ SetWidgetBounds() [2/2]

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

◆ GetWidgetBounds() [1/3]

virtual double* vtkImplicitPlaneRepresentation::GetWidgetBounds ( )
virtual

◆ GetWidgetBounds() [2/3]

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

◆ GetWidgetBounds() [3/3]

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

◆ SetConstrainToWidgetBounds()

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.

◆ GetConstrainToWidgetBounds()

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetConstrainToWidgetBounds ( )
virtual

◆ ConstrainToWidgetBoundsOn()

virtual void vtkImplicitPlaneRepresentation::ConstrainToWidgetBoundsOn ( )
virtual

◆ ConstrainToWidgetBoundsOff()

virtual void vtkImplicitPlaneRepresentation::ConstrainToWidgetBoundsOff ( )
virtual

◆ SetScaleEnabled()

virtual void vtkImplicitPlaneRepresentation::SetScaleEnabled ( vtkTypeBool  )
virtual

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

◆ GetScaleEnabled()

virtual vtkTypeBool vtkImplicitPlaneRepresentation::GetScaleEnabled ( )
virtual

◆ ScaleEnabledOn()

virtual void vtkImplicitPlaneRepresentation::ScaleEnabledOn ( )
virtual

◆ ScaleEnabledOff()

virtual void vtkImplicitPlaneRepresentation::ScaleEnabledOff ( )
virtual

◆ GetPolyData()

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.

◆ GetPolyDataAlgorithm()

vtkPolyDataAlgorithm* vtkImplicitPlaneRepresentation::GetPolyDataAlgorithm ( )

Satisfies superclass API.

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

◆ GetPlane()

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.

◆ SetPlane()

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.

◆ UpdatePlacement()

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

◆ GetNormalProperty()

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetNormalProperty ( )
virtual

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

◆ GetSelectedNormalProperty()

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetSelectedNormalProperty ( )
virtual

◆ GetPlaneProperty()

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetPlaneProperty ( )
virtual

Get the plane properties.

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

◆ GetSelectedPlaneProperty()

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetSelectedPlaneProperty ( )
virtual

◆ GetOutlineProperty()

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetOutlineProperty ( )
virtual

Get the property of the outline.

◆ GetSelectedOutlineProperty()

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetSelectedOutlineProperty ( )
virtual

◆ GetEdgesProperty()

virtual vtkProperty* vtkImplicitPlaneRepresentation::GetEdgesProperty ( )
virtual

Get the property of the intersection edges.

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

◆ SetEdgeColor() [1/3]

void vtkImplicitPlaneRepresentation::SetEdgeColor ( vtkLookupTable )

Set color to the edge.

◆ SetEdgeColor() [2/3]

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

◆ SetEdgeColor() [3/3]

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

◆ SetBumpDistance()

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.

◆ GetBumpDistance()

virtual double vtkImplicitPlaneRepresentation::GetBumpDistance ( )
virtual

◆ BumpPlane()

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.

◆ PushPlane()

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.

◆ ComputeInteractionState()

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

Methods to interface with the vtkImplicitPlaneWidget2.

Reimplemented from vtkWidgetRepresentation.

◆ PlaceWidget()

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

◆ BuildRepresentation()

void vtkImplicitPlaneRepresentation::BuildRepresentation ( )
overridevirtual

◆ StartWidgetInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ WidgetInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ EndWidgetInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ StartComplexInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ ComplexInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ ComputeComplexInteractionState()

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

Reimplemented from vtkWidgetRepresentation.

◆ EndComplexInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ GetBounds()

double* vtkImplicitPlaneRepresentation::GetBounds ( )
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

◆ GetActors()

void vtkImplicitPlaneRepresentation::GetActors ( vtkPropCollection )
overridevirtual

For some exporters and other other operations we must be able to collect all the actors or volumes.

These methods are used in that process.

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkImplicitPlaneRepresentation::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkImplicitPlaneRepresentation::RenderOpaqueGeometry ( vtkViewport )
overridevirtual

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.

There are four key render methods in vtk and they correspond to four different points in the rendering cycle. Any given prop may implement one or more of these methods. The first method is intended for rendering all opaque geometry. The second method is intended for rendering all translucent polygonal geometry. The third one is intended for rendering all translucent volumetric geometry. Most of the volume rendering mappers draw their results during this third method. The last method is to render any 2D annotation or overlays. Each of these methods return an integer value indicating whether or not this render method was applied to this data.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkImplicitPlaneRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport )
overridevirtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkImplicitPlaneRepresentation::HasTranslucentPolygonalGeometry ( )
overridevirtual

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.

A simple prop that has some translucent polygonal geometry will return true. A composite prop (like vtkAssembly) that has at least one sub-prop that has some translucent polygonal geometry will return true. Default implementation return false.

Reimplemented from vtkProp.

◆ SetInteractionState()

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.

◆ SetRepresentationState()

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.

◆ GetRepresentationState()

virtual int vtkImplicitPlaneRepresentation::GetRepresentationState ( )
virtual

◆ GetUnderlyingPlane()

vtkPlane* vtkImplicitPlaneRepresentation::GetUnderlyingPlane ( )
inline

Definition at line 403 of file vtkImplicitPlaneRepresentation.h.

◆ SetCropPlaneToBoundingBox()

virtual void vtkImplicitPlaneRepresentation::SetCropPlaneToBoundingBox ( bool  )
virtual

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

Defaults to on.

◆ GetCropPlaneToBoundingBox()

virtual bool vtkImplicitPlaneRepresentation::GetCropPlaneToBoundingBox ( )
virtual

◆ CropPlaneToBoundingBoxOn()

virtual void vtkImplicitPlaneRepresentation::CropPlaneToBoundingBoxOn ( )
virtual

◆ CropPlaneToBoundingBoxOff()

virtual void vtkImplicitPlaneRepresentation::CropPlaneToBoundingBoxOff ( )
virtual

◆ GetSnapToAxes()

virtual bool vtkImplicitPlaneRepresentation::GetSnapToAxes ( )
virtual

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

◆ SetSnapToAxes()

virtual void vtkImplicitPlaneRepresentation::SetSnapToAxes ( bool  )
virtual

◆ GetAlwaysSnapToNearestAxis()

virtual bool vtkImplicitPlaneRepresentation::GetAlwaysSnapToNearestAxis ( )
virtual

Forces the plane's normal to be aligned with x, y or z axis.

The alignment happens when calling SetNormal. It defers with SnapToAxes from it is always applicable, and SnapToAxes only snaps when the angle difference exceeds 16 degrees in complex interactions.

◆ SetAlwaysSnapToNearestAxis()

virtual void vtkImplicitPlaneRepresentation::SetAlwaysSnapToNearestAxis ( bool  snap)
inlinevirtual

Definition at line 432 of file vtkImplicitPlaneRepresentation.h.

◆ HighlightOutline()

void vtkImplicitPlaneRepresentation::HighlightOutline ( int  highlight)
protected

◆ HighlightPlane()

void vtkImplicitPlaneRepresentation::HighlightPlane ( int  highlight)
protected

◆ HighlightNormal()

void vtkImplicitPlaneRepresentation::HighlightNormal ( int  highlight)
protected

◆ RegisterPickers()

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.

◆ Rotate()

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

◆ Rotate3D()

void vtkImplicitPlaneRepresentation::Rotate3D ( double *  p1,
double *  p2 
)
protected

◆ TranslatePlane()

void vtkImplicitPlaneRepresentation::TranslatePlane ( double *  p1,
double *  p2 
)
protected

◆ TranslateOutline()

void vtkImplicitPlaneRepresentation::TranslateOutline ( double *  p1,
double *  p2 
)
protected

◆ TranslateOrigin()

void vtkImplicitPlaneRepresentation::TranslateOrigin ( double *  p1,
double *  p2 
)
protected

◆ UpdatePose()

void vtkImplicitPlaneRepresentation::UpdatePose ( double *  p1,
double *  d1,
double *  p2,
double *  d2 
)
protected

◆ Push()

void vtkImplicitPlaneRepresentation::Push ( double *  p1,
double *  p2 
)
protected

◆ Scale()

void vtkImplicitPlaneRepresentation::Scale ( double *  p1,
double *  p2,
double  X,
double  Y 
)
protected

◆ SizeHandles()

void vtkImplicitPlaneRepresentation::SizeHandles ( )
protected

◆ CreateDefaultProperties()

void vtkImplicitPlaneRepresentation::CreateDefaultProperties ( )
protected

◆ GeneratePlane()

void vtkImplicitPlaneRepresentation::GeneratePlane ( )
protected

Member Data Documentation

◆ RepresentationState

int vtkImplicitPlaneRepresentation::RepresentationState
protected

Definition at line 443 of file vtkImplicitPlaneRepresentation.h.

◆ LastEventPosition

double vtkImplicitPlaneRepresentation::LastEventPosition[3]
protected

Definition at line 446 of file vtkImplicitPlaneRepresentation.h.

◆ LastEventOrientation

double vtkImplicitPlaneRepresentation::LastEventOrientation[4]
protected

Definition at line 447 of file vtkImplicitPlaneRepresentation.h.

◆ StartEventOrientation

double vtkImplicitPlaneRepresentation::StartEventOrientation[4]
protected

Definition at line 448 of file vtkImplicitPlaneRepresentation.h.

◆ NormalToXAxis

vtkTypeBool vtkImplicitPlaneRepresentation::NormalToXAxis
protected

Definition at line 451 of file vtkImplicitPlaneRepresentation.h.

◆ NormalToYAxis

vtkTypeBool vtkImplicitPlaneRepresentation::NormalToYAxis
protected

Definition at line 452 of file vtkImplicitPlaneRepresentation.h.

◆ NormalToZAxis

vtkTypeBool vtkImplicitPlaneRepresentation::NormalToZAxis
protected

Definition at line 453 of file vtkImplicitPlaneRepresentation.h.

◆ SnappedEventOrientation

double vtkImplicitPlaneRepresentation::SnappedEventOrientation[4]
protected

Definition at line 455 of file vtkImplicitPlaneRepresentation.h.

◆ SnappedOrientation

bool vtkImplicitPlaneRepresentation::SnappedOrientation
protected

Definition at line 456 of file vtkImplicitPlaneRepresentation.h.

◆ SnapToAxes

bool vtkImplicitPlaneRepresentation::SnapToAxes
protected

Definition at line 457 of file vtkImplicitPlaneRepresentation.h.

◆ AlwaysSnapToNearestAxis

bool vtkImplicitPlaneRepresentation::AlwaysSnapToNearestAxis
protected

Definition at line 459 of file vtkImplicitPlaneRepresentation.h.

◆ LockNormalToCamera

vtkTypeBool vtkImplicitPlaneRepresentation::LockNormalToCamera
protected

Definition at line 462 of file vtkImplicitPlaneRepresentation.h.

◆ BumpDistance

double vtkImplicitPlaneRepresentation::BumpDistance
protected

Definition at line 465 of file vtkImplicitPlaneRepresentation.h.

◆ Plane

vtkPlane* vtkImplicitPlaneRepresentation::Plane
protected

Definition at line 468 of file vtkImplicitPlaneRepresentation.h.

◆ TranslationAxis

int vtkImplicitPlaneRepresentation::TranslationAxis
protected

Definition at line 470 of file vtkImplicitPlaneRepresentation.h.

◆ Box

vtkImageData* vtkImplicitPlaneRepresentation::Box
protected

Definition at line 473 of file vtkImplicitPlaneRepresentation.h.

◆ Outline

vtkOutlineFilter* vtkImplicitPlaneRepresentation::Outline
protected

Definition at line 474 of file vtkImplicitPlaneRepresentation.h.

◆ OutlineMapper

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::OutlineMapper
protected

Definition at line 475 of file vtkImplicitPlaneRepresentation.h.

◆ OutlineActor

vtkActor* vtkImplicitPlaneRepresentation::OutlineActor
protected

Definition at line 476 of file vtkImplicitPlaneRepresentation.h.

◆ OutlineTranslation

vtkTypeBool vtkImplicitPlaneRepresentation::OutlineTranslation
protected

Definition at line 478 of file vtkImplicitPlaneRepresentation.h.

◆ ScaleEnabled

vtkTypeBool vtkImplicitPlaneRepresentation::ScaleEnabled
protected

Definition at line 479 of file vtkImplicitPlaneRepresentation.h.

◆ OutsideBounds

vtkTypeBool vtkImplicitPlaneRepresentation::OutsideBounds
protected

Definition at line 480 of file vtkImplicitPlaneRepresentation.h.

◆ WidgetBounds

double vtkImplicitPlaneRepresentation::WidgetBounds[6]
protected

Definition at line 481 of file vtkImplicitPlaneRepresentation.h.

◆ ConstrainToWidgetBounds

vtkTypeBool vtkImplicitPlaneRepresentation::ConstrainToWidgetBounds
protected

Definition at line 482 of file vtkImplicitPlaneRepresentation.h.

◆ Cutter

vtkCutter* vtkImplicitPlaneRepresentation::Cutter
protected

Definition at line 485 of file vtkImplicitPlaneRepresentation.h.

◆ PlaneSource

vtkPlaneSource* vtkImplicitPlaneRepresentation::PlaneSource
protected

Definition at line 486 of file vtkImplicitPlaneRepresentation.h.

◆ CutMapper

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::CutMapper
protected

Definition at line 487 of file vtkImplicitPlaneRepresentation.h.

◆ CutActor

vtkActor* vtkImplicitPlaneRepresentation::CutActor
protected

Definition at line 488 of file vtkImplicitPlaneRepresentation.h.

◆ DrawPlane

vtkTypeBool vtkImplicitPlaneRepresentation::DrawPlane
protected

Definition at line 489 of file vtkImplicitPlaneRepresentation.h.

◆ DrawOutline

vtkTypeBool vtkImplicitPlaneRepresentation::DrawOutline
protected

Definition at line 490 of file vtkImplicitPlaneRepresentation.h.

◆ Edges

vtkFeatureEdges* vtkImplicitPlaneRepresentation::Edges
protected

Definition at line 494 of file vtkImplicitPlaneRepresentation.h.

◆ EdgesTuber

vtkTubeFilter* vtkImplicitPlaneRepresentation::EdgesTuber
protected

Definition at line 495 of file vtkImplicitPlaneRepresentation.h.

◆ EdgesMapper

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::EdgesMapper
protected

Definition at line 496 of file vtkImplicitPlaneRepresentation.h.

◆ EdgesActor

vtkActor* vtkImplicitPlaneRepresentation::EdgesActor
protected

Definition at line 497 of file vtkImplicitPlaneRepresentation.h.

◆ Tubing

vtkTypeBool vtkImplicitPlaneRepresentation::Tubing
protected

Definition at line 498 of file vtkImplicitPlaneRepresentation.h.

◆ ConeSource

vtkConeSource* vtkImplicitPlaneRepresentation::ConeSource
protected

Definition at line 501 of file vtkImplicitPlaneRepresentation.h.

◆ ConeMapper

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::ConeMapper
protected

Definition at line 502 of file vtkImplicitPlaneRepresentation.h.

◆ ConeActor

vtkActor* vtkImplicitPlaneRepresentation::ConeActor
protected

Definition at line 503 of file vtkImplicitPlaneRepresentation.h.

◆ LineSource

vtkLineSource* vtkImplicitPlaneRepresentation::LineSource
protected

Definition at line 507 of file vtkImplicitPlaneRepresentation.h.

◆ LineMapper

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::LineMapper
protected

Definition at line 508 of file vtkImplicitPlaneRepresentation.h.

◆ LineActor

vtkActor* vtkImplicitPlaneRepresentation::LineActor
protected

Definition at line 509 of file vtkImplicitPlaneRepresentation.h.

◆ ConeSource2

vtkConeSource* vtkImplicitPlaneRepresentation::ConeSource2
protected

Definition at line 512 of file vtkImplicitPlaneRepresentation.h.

◆ ConeMapper2

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::ConeMapper2
protected

Definition at line 513 of file vtkImplicitPlaneRepresentation.h.

◆ ConeActor2

vtkActor* vtkImplicitPlaneRepresentation::ConeActor2
protected

Definition at line 514 of file vtkImplicitPlaneRepresentation.h.

◆ LineSource2

vtkLineSource* vtkImplicitPlaneRepresentation::LineSource2
protected

Definition at line 517 of file vtkImplicitPlaneRepresentation.h.

◆ LineMapper2

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::LineMapper2
protected

Definition at line 518 of file vtkImplicitPlaneRepresentation.h.

◆ LineActor2

vtkActor* vtkImplicitPlaneRepresentation::LineActor2
protected

Definition at line 519 of file vtkImplicitPlaneRepresentation.h.

◆ Sphere

vtkSphereSource* vtkImplicitPlaneRepresentation::Sphere
protected

Definition at line 522 of file vtkImplicitPlaneRepresentation.h.

◆ SphereMapper

vtkPolyDataMapper* vtkImplicitPlaneRepresentation::SphereMapper
protected

Definition at line 523 of file vtkImplicitPlaneRepresentation.h.

◆ SphereActor

vtkActor* vtkImplicitPlaneRepresentation::SphereActor
protected

Definition at line 524 of file vtkImplicitPlaneRepresentation.h.

◆ Picker

vtkCellPicker* vtkImplicitPlaneRepresentation::Picker
protected

Definition at line 527 of file vtkImplicitPlaneRepresentation.h.

◆ Transform

vtkTransform* vtkImplicitPlaneRepresentation::Transform
protected

Definition at line 533 of file vtkImplicitPlaneRepresentation.h.

◆ NormalProperty

vtkProperty* vtkImplicitPlaneRepresentation::NormalProperty
protected

Definition at line 548 of file vtkImplicitPlaneRepresentation.h.

◆ SelectedNormalProperty

vtkProperty* vtkImplicitPlaneRepresentation::SelectedNormalProperty
protected

Definition at line 549 of file vtkImplicitPlaneRepresentation.h.

◆ PlaneProperty

vtkProperty* vtkImplicitPlaneRepresentation::PlaneProperty
protected

Definition at line 550 of file vtkImplicitPlaneRepresentation.h.

◆ SelectedPlaneProperty

vtkProperty* vtkImplicitPlaneRepresentation::SelectedPlaneProperty
protected

Definition at line 551 of file vtkImplicitPlaneRepresentation.h.

◆ OutlineProperty

vtkProperty* vtkImplicitPlaneRepresentation::OutlineProperty
protected

Definition at line 552 of file vtkImplicitPlaneRepresentation.h.

◆ SelectedOutlineProperty

vtkProperty* vtkImplicitPlaneRepresentation::SelectedOutlineProperty
protected

Definition at line 553 of file vtkImplicitPlaneRepresentation.h.

◆ EdgesProperty

vtkProperty* vtkImplicitPlaneRepresentation::EdgesProperty
protected

Definition at line 554 of file vtkImplicitPlaneRepresentation.h.

◆ CropPlaneToBoundingBox

bool vtkImplicitPlaneRepresentation::CropPlaneToBoundingBox
protected

Definition at line 559 of file vtkImplicitPlaneRepresentation.h.

◆ BoundingBox

vtkBox* vtkImplicitPlaneRepresentation::BoundingBox
protected

Definition at line 562 of file vtkImplicitPlaneRepresentation.h.


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