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

represent the vtkFinitePlaneWidget. More...

#include <vtkFinitePlaneRepresentation.h>

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

Public Types

enum  _InteractionState {
  Outside = 0, MoveOrigin, ModifyV1, ModifyV2,
  Moving, Rotating, Pushing
}
 
typedef vtkWidgetRepresentation Superclass
 Standard vtkObject methods. 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...
 
vtkFinitePlaneRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void GetPolyData (vtkPolyData *pd)
 Grab the polydata that defines the plane. More...
 
virtual vtkPropertyGetV1HandleProperty ()
 Get the handle properties (the little balls are the handles). More...
 
virtual vtkPropertyGetV2HandleProperty ()
 
virtual vtkPropertyGetSelectedHandleProperty ()
 
virtual vtkPropertyGetPlaneProperty ()
 Get the plane properties. More...
 
virtual vtkPropertyGetSelectedPlaneProperty ()
 
virtual void SetTubing (bool)
 Turn on/off tubing of the wire outline of the plane. More...
 
virtual bool GetTubing ()
 
virtual void TubingOn ()
 
virtual void TubingOff ()
 
void SetDrawPlane (bool plane)
 Enable/disable the drawing of the plane. More...
 
virtual bool GetDrawPlane ()
 
virtual void DrawPlaneOn ()
 
virtual void DrawPlaneOff ()
 
void SetHandles (bool handles)
 Switches handles (the spheres) on or off by manipulating the underlying actor visibility. More...
 
virtual void HandlesOn ()
 
virtual void HandlesOff ()
 
void PlaceWidget (double bounds[6]) override
 These are methods that satisfy vtkWidgetRepresentation's API. More...
 
void BuildRepresentation () override
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 
void StartWidgetInteraction (double e[2]) override
 
void WidgetInteraction (double e[2]) override
 
doubleGetBounds () override
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Methods supporting, and required by, the rendering process. 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)
 
void SetOrigin (double x, double y, double z)
 Set/Get the origin of the plane. More...
 
void SetOrigin (double x[3])
 
virtual doubleGetOrigin ()
 
virtual void GetOrigin (double &, double &, double &)
 
virtual void GetOrigin (double[3])
 
void SetNormal (double x, double y, double z)
 Set/Get the normal to the plane. More...
 
void SetNormal (double x[3])
 
virtual doubleGetNormal ()
 
virtual void GetNormal (double &, double &, double &)
 
virtual void GetNormal (double[3])
 
void SetV1 (double x, double y)
 Set/Get the v1 vector of the plane. More...
 
void SetV1 (double x[2])
 
virtual doubleGetV1 ()
 
virtual void GetV1 (double &, double &)
 
virtual void GetV1 (double[2])
 
void SetV2 (double x, double y)
 Set/Get the v2 vector of the plane. More...
 
void SetV2 (double x[2])
 
virtual doubleGetV2 ()
 
virtual void GetV2 (double &, double &)
 
virtual void GetV2 (double[2])
 
virtual void SetRepresentationState (int)
 Sets the visual appearance of the representation based on the state it is in. More...
 
virtual int GetRepresentationState ()
 
virtual vtkPropertyGetNormalProperty ()
 Get the properties on the normal (line and cone). More...
 
virtual vtkPropertyGetSelectedNormalProperty ()
 
void TranslateOrigin (double *p1, double *p2)
 
void MovePoint1 (double *p1, double *p2)
 
void MovePoint2 (double *p1, double *p2)
 
void Push (double *p1, double *p2)
 
void Rotate (int X, int Y, double *p1, double *p2, double *vpn)
 
void RegisterPickers () override
 Register internal Pickers in the Picking Manager. More...
 
- 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 void EndWidgetInteraction (double newEventPos[2])
 
virtual int GetInteractionState ()
 
virtual void Highlight (int vtkNotUsed(highlightOn))
 
virtual void StartComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual void ComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual void EndComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual int ComputeComplexInteractionState (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *callData, int modify=0)
 
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 ()
 
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...
 
- 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 vtkFinitePlaneRepresentationNew ()
 Instantiate the class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkFinitePlaneRepresentationSafeDownCast (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
 
 vtkFinitePlaneRepresentation ()
 
 ~vtkFinitePlaneRepresentation () override
 
virtual void CreateDefaultProperties ()
 
virtual void SizeHandles ()
 
void SetHighlightNormal (int highlight)
 
void SetHighlightPlane (int highlight)
 
void SetHighlightHandle (vtkProp *prop)
 
- 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

double LastEventPosition [3]
 
int RepresentationState
 
vtkSphereSourceOriginGeometry
 
vtkPolyDataMapperOriginMapper
 
vtkActorOriginActor
 
double Origin [3]
 
double Normal [3]
 
double PreviousNormal [3]
 
vtkTransformTransform
 
vtkSphereSourceV1Geometry
 
vtkPolyDataMapperV1Mapper
 
vtkActorV1Actor
 
double V1 [3]
 
vtkSphereSourceV2Geometry
 
vtkPolyDataMapperV2Mapper
 
vtkActorV2Actor
 
double V2 [3]
 
vtkConeSourceConeSource
 
vtkPolyDataMapperConeMapper
 
vtkActorConeActor
 
vtkLineSourceLineSource
 
vtkPolyDataMapperLineMapper
 
vtkActorLineActor
 
vtkConeSourceConeSource2
 
vtkPolyDataMapperConeMapper2
 
vtkActorConeActor2
 
vtkLineSourceLineSource2
 
vtkPolyDataMapperLineMapper2
 
vtkActorLineActor2
 
vtkPolyDataPlanePolyData
 
vtkPolyDataMapperPlaneMapper
 
vtkActorPlaneActor
 
vtkFeatureEdgesEdges
 
vtkTubeFilterEdgesTuber
 
vtkPolyDataMapperEdgesMapper
 
vtkActorEdgesActor
 
bool Tubing
 
bool DrawPlane
 
vtkCellPickerHandlePicker
 
vtkActorCurrentHandle
 
vtkTransformTransformRotation
 
vtkBoxBoundingBox
 
vtkPropertyOriginHandleProperty
 
vtkPropertyV1HandleProperty
 
vtkPropertyV2HandleProperty
 
vtkPropertySelectedHandleProperty
 
vtkPropertyPlaneProperty
 
vtkPropertySelectedPlaneProperty
 
vtkPropertyNormalProperty
 
vtkPropertySelectedNormalProperty
 
- 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

represent the vtkFinitePlaneWidget.

This class is a concrete representation for the vtkFinitePlaneWidget. It represents a plane with three handles: one on two faces, plus a center handle. Through interaction with the widget, the plane representation can be arbitrarily positioned and modified in the 3D space.

To use this representation, you normally use the PlaceWidget() method to position the widget at a specified region in space.

See also
vtkFinitePlaneWidget vtkImplicitPlaneWidget2
Tests:
vtkFinitePlaneRepresentation (Tests)

Definition at line 53 of file vtkFinitePlaneRepresentation.h.

Member Typedef Documentation

◆ Superclass

Standard vtkObject methods.

Definition at line 65 of file vtkFinitePlaneRepresentation.h.

Member Enumeration Documentation

◆ _InteractionState

Enumerator
Outside 
MoveOrigin 
ModifyV1 
ModifyV2 
Moving 
Rotating 
Pushing 

Definition at line 212 of file vtkFinitePlaneRepresentation.h.

Constructor & Destructor Documentation

◆ vtkFinitePlaneRepresentation()

vtkFinitePlaneRepresentation::vtkFinitePlaneRepresentation ( )
protected

◆ ~vtkFinitePlaneRepresentation()

vtkFinitePlaneRepresentation::~vtkFinitePlaneRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkFinitePlaneRepresentation* vtkFinitePlaneRepresentation::New ( )
static

Instantiate the class.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkFinitePlaneRepresentation::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 vtkFinitePlaneRepresentation* vtkFinitePlaneRepresentation::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkFinitePlaneRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkWidgetRepresentation.

◆ NewInstance()

vtkFinitePlaneRepresentation* vtkFinitePlaneRepresentation::NewInstance ( ) const

◆ PrintSelf()

void vtkFinitePlaneRepresentation::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.

◆ GetPolyData()

void vtkFinitePlaneRepresentation::GetPolyData ( vtkPolyData pd)

Grab the polydata that defines the plane.

The polydata contains a single polygon.

◆ GetV1HandleProperty()

virtual vtkProperty* vtkFinitePlaneRepresentation::GetV1HandleProperty ( )
virtual

Get the handle properties (the little balls are the handles).

The properties of the handles, when selected or normal, can be specified.

◆ GetV2HandleProperty()

virtual vtkProperty* vtkFinitePlaneRepresentation::GetV2HandleProperty ( )
virtual

◆ GetSelectedHandleProperty()

virtual vtkProperty* vtkFinitePlaneRepresentation::GetSelectedHandleProperty ( )
virtual

◆ GetPlaneProperty()

virtual vtkProperty* vtkFinitePlaneRepresentation::GetPlaneProperty ( )
virtual

Get the plane properties.

The properties of the plane when selected and normal can be set.

◆ GetSelectedPlaneProperty()

virtual vtkProperty* vtkFinitePlaneRepresentation::GetSelectedPlaneProperty ( )
virtual

◆ SetTubing()

virtual void vtkFinitePlaneRepresentation::SetTubing ( bool  )
virtual

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

The tube thickens the line by wrapping with a vtkTubeFilter.

◆ GetTubing()

virtual bool vtkFinitePlaneRepresentation::GetTubing ( )
virtual

◆ TubingOn()

virtual void vtkFinitePlaneRepresentation::TubingOn ( )
virtual

◆ TubingOff()

virtual void vtkFinitePlaneRepresentation::TubingOff ( )
virtual

◆ SetDrawPlane()

void vtkFinitePlaneRepresentation::SetDrawPlane ( bool  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 bool vtkFinitePlaneRepresentation::GetDrawPlane ( )
virtual

◆ DrawPlaneOn()

virtual void vtkFinitePlaneRepresentation::DrawPlaneOn ( )
virtual

◆ DrawPlaneOff()

virtual void vtkFinitePlaneRepresentation::DrawPlaneOff ( )
virtual

◆ SetHandles()

void vtkFinitePlaneRepresentation::SetHandles ( bool  handles)

Switches handles (the spheres) on or off by manipulating the underlying actor visibility.

◆ HandlesOn()

virtual void vtkFinitePlaneRepresentation::HandlesOn ( )
virtual

◆ HandlesOff()

virtual void vtkFinitePlaneRepresentation::HandlesOff ( )
virtual

◆ PlaceWidget()

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

These are methods that satisfy vtkWidgetRepresentation's API.

◆ BuildRepresentation()

void vtkFinitePlaneRepresentation::BuildRepresentation ( )
overridevirtual

◆ ComputeInteractionState()

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

Reimplemented from vtkWidgetRepresentation.

◆ StartWidgetInteraction()

void vtkFinitePlaneRepresentation::StartWidgetInteraction ( double  e[2])
overridevirtual

Reimplemented from vtkWidgetRepresentation.

◆ WidgetInteraction()

void vtkFinitePlaneRepresentation::WidgetInteraction ( double  e[2])
overridevirtual

Reimplemented from vtkWidgetRepresentation.

◆ GetBounds()

double* vtkFinitePlaneRepresentation::GetBounds ( void  )
overridevirtual

Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

in world coordinates. NULL means that the bounds are not defined.

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkFinitePlaneRepresentation::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkFinitePlaneRepresentation::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 vtkFinitePlaneRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport )
overridevirtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkFinitePlaneRepresentation::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 vtkFinitePlaneRepresentation::SetInteractionState ( int  )
virtual

◆ SetOrigin() [1/2]

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

Set/Get the origin of the plane.

◆ SetOrigin() [2/2]

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

◆ GetOrigin() [1/3]

virtual double* vtkFinitePlaneRepresentation::GetOrigin ( )
virtual

◆ GetOrigin() [2/3]

virtual void vtkFinitePlaneRepresentation::GetOrigin ( double ,
double ,
double  
)
virtual

◆ GetOrigin() [3/3]

virtual void vtkFinitePlaneRepresentation::GetOrigin ( double  [3])
virtual

◆ SetNormal() [1/2]

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

Set/Get the normal to the plane.

◆ SetNormal() [2/2]

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

◆ GetNormal() [1/3]

virtual double* vtkFinitePlaneRepresentation::GetNormal ( )
virtual

◆ GetNormal() [2/3]

virtual void vtkFinitePlaneRepresentation::GetNormal ( double ,
double ,
double  
)
virtual

◆ GetNormal() [3/3]

virtual void vtkFinitePlaneRepresentation::GetNormal ( double  [3])
virtual

◆ SetV1() [1/2]

void vtkFinitePlaneRepresentation::SetV1 ( double  x,
double  y 
)

Set/Get the v1 vector of the plane.

◆ SetV1() [2/2]

void vtkFinitePlaneRepresentation::SetV1 ( double  x[2])

◆ GetV1() [1/3]

virtual double* vtkFinitePlaneRepresentation::GetV1 ( )
virtual

◆ GetV1() [2/3]

virtual void vtkFinitePlaneRepresentation::GetV1 ( double ,
double  
)
virtual

◆ GetV1() [3/3]

virtual void vtkFinitePlaneRepresentation::GetV1 ( double  [2])
virtual

◆ SetV2() [1/2]

void vtkFinitePlaneRepresentation::SetV2 ( double  x,
double  y 
)

Set/Get the v2 vector of the plane.

◆ SetV2() [2/2]

void vtkFinitePlaneRepresentation::SetV2 ( double  x[2])

◆ GetV2() [1/3]

virtual double* vtkFinitePlaneRepresentation::GetV2 ( )
virtual

◆ GetV2() [2/3]

virtual void vtkFinitePlaneRepresentation::GetV2 ( double ,
double  
)
virtual

◆ GetV2() [3/3]

virtual void vtkFinitePlaneRepresentation::GetV2 ( double  [2])
virtual

◆ SetRepresentationState()

virtual void vtkFinitePlaneRepresentation::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 vtkFinitePlaneRepresentation::GetRepresentationState ( )
virtual

◆ GetNormalProperty()

virtual vtkProperty* vtkFinitePlaneRepresentation::GetNormalProperty ( )
virtual

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

◆ GetSelectedNormalProperty()

virtual vtkProperty* vtkFinitePlaneRepresentation::GetSelectedNormalProperty ( )
virtual

◆ TranslateOrigin()

void vtkFinitePlaneRepresentation::TranslateOrigin ( double p1,
double p2 
)

◆ MovePoint1()

void vtkFinitePlaneRepresentation::MovePoint1 ( double p1,
double p2 
)

◆ MovePoint2()

void vtkFinitePlaneRepresentation::MovePoint2 ( double p1,
double p2 
)

◆ Push()

void vtkFinitePlaneRepresentation::Push ( double p1,
double p2 
)

◆ Rotate()

void vtkFinitePlaneRepresentation::Rotate ( int  X,
int  Y,
double p1,
double p2,
double vpn 
)

◆ RegisterPickers()

void vtkFinitePlaneRepresentation::RegisterPickers ( )
overridevirtual

Register internal Pickers in the Picking Manager.

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

Reimplemented from vtkWidgetRepresentation.

◆ CreateDefaultProperties()

virtual void vtkFinitePlaneRepresentation::CreateDefaultProperties ( )
protectedvirtual

◆ SizeHandles()

virtual void vtkFinitePlaneRepresentation::SizeHandles ( )
protectedvirtual

◆ SetHighlightNormal()

void vtkFinitePlaneRepresentation::SetHighlightNormal ( int  highlight)
protected

◆ SetHighlightPlane()

void vtkFinitePlaneRepresentation::SetHighlightPlane ( int  highlight)
protected

◆ SetHighlightHandle()

void vtkFinitePlaneRepresentation::SetHighlightHandle ( vtkProp prop)
protected

Member Data Documentation

◆ LastEventPosition

double vtkFinitePlaneRepresentation::LastEventPosition[3]
protected

Definition at line 241 of file vtkFinitePlaneRepresentation.h.

◆ RepresentationState

int vtkFinitePlaneRepresentation::RepresentationState
protected

Definition at line 244 of file vtkFinitePlaneRepresentation.h.

◆ OriginGeometry

vtkSphereSource* vtkFinitePlaneRepresentation::OriginGeometry
protected

Definition at line 247 of file vtkFinitePlaneRepresentation.h.

◆ OriginMapper

vtkPolyDataMapper* vtkFinitePlaneRepresentation::OriginMapper
protected

Definition at line 248 of file vtkFinitePlaneRepresentation.h.

◆ OriginActor

vtkActor* vtkFinitePlaneRepresentation::OriginActor
protected

Definition at line 249 of file vtkFinitePlaneRepresentation.h.

◆ Origin

double vtkFinitePlaneRepresentation::Origin[3]
protected

Definition at line 250 of file vtkFinitePlaneRepresentation.h.

◆ Normal

double vtkFinitePlaneRepresentation::Normal[3]
protected

Definition at line 253 of file vtkFinitePlaneRepresentation.h.

◆ PreviousNormal

double vtkFinitePlaneRepresentation::PreviousNormal[3]
protected

Definition at line 256 of file vtkFinitePlaneRepresentation.h.

◆ Transform

vtkTransform* vtkFinitePlaneRepresentation::Transform
protected

Definition at line 259 of file vtkFinitePlaneRepresentation.h.

◆ V1Geometry

vtkSphereSource* vtkFinitePlaneRepresentation::V1Geometry
protected

Definition at line 262 of file vtkFinitePlaneRepresentation.h.

◆ V1Mapper

vtkPolyDataMapper* vtkFinitePlaneRepresentation::V1Mapper
protected

Definition at line 263 of file vtkFinitePlaneRepresentation.h.

◆ V1Actor

vtkActor* vtkFinitePlaneRepresentation::V1Actor
protected

Definition at line 264 of file vtkFinitePlaneRepresentation.h.

◆ V1

double vtkFinitePlaneRepresentation::V1[3]
protected

Definition at line 265 of file vtkFinitePlaneRepresentation.h.

◆ V2Geometry

vtkSphereSource* vtkFinitePlaneRepresentation::V2Geometry
protected

Definition at line 268 of file vtkFinitePlaneRepresentation.h.

◆ V2Mapper

vtkPolyDataMapper* vtkFinitePlaneRepresentation::V2Mapper
protected

Definition at line 269 of file vtkFinitePlaneRepresentation.h.

◆ V2Actor

vtkActor* vtkFinitePlaneRepresentation::V2Actor
protected

Definition at line 270 of file vtkFinitePlaneRepresentation.h.

◆ V2

double vtkFinitePlaneRepresentation::V2[3]
protected

Definition at line 271 of file vtkFinitePlaneRepresentation.h.

◆ ConeSource

vtkConeSource* vtkFinitePlaneRepresentation::ConeSource
protected

Definition at line 274 of file vtkFinitePlaneRepresentation.h.

◆ ConeMapper

vtkPolyDataMapper* vtkFinitePlaneRepresentation::ConeMapper
protected

Definition at line 275 of file vtkFinitePlaneRepresentation.h.

◆ ConeActor

vtkActor* vtkFinitePlaneRepresentation::ConeActor
protected

Definition at line 276 of file vtkFinitePlaneRepresentation.h.

◆ LineSource

vtkLineSource* vtkFinitePlaneRepresentation::LineSource
protected

Definition at line 279 of file vtkFinitePlaneRepresentation.h.

◆ LineMapper

vtkPolyDataMapper* vtkFinitePlaneRepresentation::LineMapper
protected

Definition at line 280 of file vtkFinitePlaneRepresentation.h.

◆ LineActor

vtkActor* vtkFinitePlaneRepresentation::LineActor
protected

Definition at line 281 of file vtkFinitePlaneRepresentation.h.

◆ ConeSource2

vtkConeSource* vtkFinitePlaneRepresentation::ConeSource2
protected

Definition at line 284 of file vtkFinitePlaneRepresentation.h.

◆ ConeMapper2

vtkPolyDataMapper* vtkFinitePlaneRepresentation::ConeMapper2
protected

Definition at line 285 of file vtkFinitePlaneRepresentation.h.

◆ ConeActor2

vtkActor* vtkFinitePlaneRepresentation::ConeActor2
protected

Definition at line 286 of file vtkFinitePlaneRepresentation.h.

◆ LineSource2

vtkLineSource* vtkFinitePlaneRepresentation::LineSource2
protected

Definition at line 289 of file vtkFinitePlaneRepresentation.h.

◆ LineMapper2

vtkPolyDataMapper* vtkFinitePlaneRepresentation::LineMapper2
protected

Definition at line 290 of file vtkFinitePlaneRepresentation.h.

◆ LineActor2

vtkActor* vtkFinitePlaneRepresentation::LineActor2
protected

Definition at line 291 of file vtkFinitePlaneRepresentation.h.

◆ PlanePolyData

vtkPolyData* vtkFinitePlaneRepresentation::PlanePolyData
protected

Definition at line 294 of file vtkFinitePlaneRepresentation.h.

◆ PlaneMapper

vtkPolyDataMapper* vtkFinitePlaneRepresentation::PlaneMapper
protected

Definition at line 295 of file vtkFinitePlaneRepresentation.h.

◆ PlaneActor

vtkActor* vtkFinitePlaneRepresentation::PlaneActor
protected

Definition at line 296 of file vtkFinitePlaneRepresentation.h.

◆ Edges

vtkFeatureEdges* vtkFinitePlaneRepresentation::Edges
protected

Definition at line 299 of file vtkFinitePlaneRepresentation.h.

◆ EdgesTuber

vtkTubeFilter* vtkFinitePlaneRepresentation::EdgesTuber
protected

Definition at line 300 of file vtkFinitePlaneRepresentation.h.

◆ EdgesMapper

vtkPolyDataMapper* vtkFinitePlaneRepresentation::EdgesMapper
protected

Definition at line 301 of file vtkFinitePlaneRepresentation.h.

◆ EdgesActor

vtkActor* vtkFinitePlaneRepresentation::EdgesActor
protected

Definition at line 302 of file vtkFinitePlaneRepresentation.h.

◆ Tubing

bool vtkFinitePlaneRepresentation::Tubing
protected

Definition at line 303 of file vtkFinitePlaneRepresentation.h.

◆ DrawPlane

bool vtkFinitePlaneRepresentation::DrawPlane
protected

Definition at line 304 of file vtkFinitePlaneRepresentation.h.

◆ HandlePicker

vtkCellPicker* vtkFinitePlaneRepresentation::HandlePicker
protected

Definition at line 307 of file vtkFinitePlaneRepresentation.h.

◆ CurrentHandle

vtkActor* vtkFinitePlaneRepresentation::CurrentHandle
protected

Definition at line 308 of file vtkFinitePlaneRepresentation.h.

◆ TransformRotation

vtkTransform* vtkFinitePlaneRepresentation::TransformRotation
protected

Definition at line 311 of file vtkFinitePlaneRepresentation.h.

◆ BoundingBox

vtkBox* vtkFinitePlaneRepresentation::BoundingBox
protected

Definition at line 314 of file vtkFinitePlaneRepresentation.h.

◆ OriginHandleProperty

vtkProperty* vtkFinitePlaneRepresentation::OriginHandleProperty
protected

Definition at line 318 of file vtkFinitePlaneRepresentation.h.

◆ V1HandleProperty

vtkProperty* vtkFinitePlaneRepresentation::V1HandleProperty
protected

Definition at line 319 of file vtkFinitePlaneRepresentation.h.

◆ V2HandleProperty

vtkProperty* vtkFinitePlaneRepresentation::V2HandleProperty
protected

Definition at line 320 of file vtkFinitePlaneRepresentation.h.

◆ SelectedHandleProperty

vtkProperty* vtkFinitePlaneRepresentation::SelectedHandleProperty
protected

Definition at line 321 of file vtkFinitePlaneRepresentation.h.

◆ PlaneProperty

vtkProperty* vtkFinitePlaneRepresentation::PlaneProperty
protected

Definition at line 322 of file vtkFinitePlaneRepresentation.h.

◆ SelectedPlaneProperty

vtkProperty* vtkFinitePlaneRepresentation::SelectedPlaneProperty
protected

Definition at line 323 of file vtkFinitePlaneRepresentation.h.

◆ NormalProperty

vtkProperty* vtkFinitePlaneRepresentation::NormalProperty
protected

Definition at line 324 of file vtkFinitePlaneRepresentation.h.

◆ SelectedNormalProperty

vtkProperty* vtkFinitePlaneRepresentation::SelectedNormalProperty
protected

Definition at line 325 of file vtkFinitePlaneRepresentation.h.


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