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

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

#include <vtkLineRepresentation.h>

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

Public Types

enum  {
  Outside = 0, OnP1, OnP2, TranslatingP1,
  TranslatingP2, OnLine, Scaling
}
 
enum  { RestrictNone = 0, RestrictToX, RestrictToY, RestrictToZ }
 
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...
 
vtkLineRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void GetPoint1WorldPosition (double pos[3])
 Methods to Set/Get the coordinates of the two points defining this representation. More...
 
double * GetPoint1WorldPosition ()
 
void GetPoint1DisplayPosition (double pos[3])
 
double * GetPoint1DisplayPosition ()
 
void SetPoint1WorldPosition (double pos[3])
 
void SetPoint1DisplayPosition (double pos[3])
 
void GetPoint2DisplayPosition (double pos[3])
 
double * GetPoint2DisplayPosition ()
 
void GetPoint2WorldPosition (double pos[3])
 
double * GetPoint2WorldPosition ()
 
void SetPoint2WorldPosition (double pos[3])
 
void SetPoint2DisplayPosition (double pos[3])
 
void SetHandleRepresentation (vtkPointHandleRepresentation3D *handle)
 This method is used to specify the type of handle representation to use for the three internal vtkHandleWidgets within vtkLineWidget2. More...
 
void InstantiateHandleRepresentation ()
 
virtual vtkPointHandleRepresentation3DGetPoint1Representation ()
 Get the three handle representations used for the vtkLineWidget2. More...
 
virtual vtkPointHandleRepresentation3DGetPoint2Representation ()
 
virtual vtkPointHandleRepresentation3DGetLineHandleRepresentation ()
 
virtual vtkPropertyGetEndPointProperty ()
 Get the end-point (sphere) properties. More...
 
virtual vtkPropertyGetSelectedEndPointProperty ()
 
virtual vtkPropertyGetEndPoint2Property ()
 Get the end-point (sphere) properties. More...
 
virtual vtkPropertyGetSelectedEndPoint2Property ()
 
virtual vtkPropertyGetLineProperty ()
 Get the line properties. More...
 
virtual vtkPropertyGetSelectedLineProperty ()
 
virtual void SetTolerance (int)
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the line or end point to be active. More...
 
virtual int GetTolerance ()
 
void SetResolution (int res)
 Set/Get the resolution (number of subdivisions) of the line. More...
 
int GetResolution ()
 
void GetPolyData (vtkPolyData *pd)
 Retrieve the polydata (including points) that defines the line. More...
 
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
 
double * GetBounds () override
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
void GetActors (vtkPropCollection *pc) override
 Methods supporting the rendering process. 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., vtkLineWidget2) 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 ()
 
void SetDirectionalLine (bool val)
 Sets the representation to be a directional line with point 1 represented as a cone. More...
 
virtual bool GetDirectionalLine ()
 
virtual void DirectionalLineOn ()
 
virtual void DirectionalLineOff ()
 
vtkMTimeType GetMTime () override
 Overload the superclasses' GetMTime() because internal classes are used to keep the state of the representation. More...
 
void SetRenderer (vtkRenderer *ren) override
 Overridden to set the rendererer on the internal representations. More...
 
virtual void SetDistanceAnnotationVisibility (vtkTypeBool)
 Show the distance between the points. More...
 
virtual vtkTypeBool GetDistanceAnnotationVisibility ()
 
virtual void DistanceAnnotationVisibilityOn ()
 
virtual void DistanceAnnotationVisibilityOff ()
 
virtual void SetDistanceAnnotationFormat (const char *)
 Specify the format to use for labelling the line. More...
 
virtual char * GetDistanceAnnotationFormat ()
 
void SetDistanceAnnotationScale (double x, double y, double z)
 Scale text (font size along each dimension). More...
 
virtual void SetDistanceAnnotationScale (double scale[3])
 
virtual double * GetDistanceAnnotationScale ()
 
double GetDistance ()
 Get the distance between the points. More...
 
void SetLineColor (double r, double g, double b)
 Convenience method to set the line color. More...
 
virtual vtkPropertyGetDistanceAnnotationProperty ()
 Get the distance annotation property. More...
 
virtual vtkFollowerGetTextActor ()
 Get the text actor. More...
 
void SetRestrictFlag (int restrict_flag)
 Set if translations should be restricted to one of the axes (disabled if RestrictNone is specified). 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 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 ()
 
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 RegisterPickers ()
 Register internal Pickers in the Picking Manager. 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...
 
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 vtkLineRepresentationNew ()
 Instantiate the class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLineRepresentationSafeDownCast (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
 
 vtkLineRepresentation ()
 
 ~vtkLineRepresentation () override
 
void CreateDefaultProperties ()
 
void ClampPosition (double x[3])
 
void HighlightPoint (int ptId, int highlight)
 
void HighlightLine (int highlight)
 
int InBounds (double x[3])
 
void SizeHandles ()
 
- 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

vtkPointHandleRepresentation3DHandleRepresentation
 
vtkPointHandleRepresentation3DPoint1Representation
 
vtkPointHandleRepresentation3DPoint2Representation
 
vtkPointHandleRepresentation3DLineHandleRepresentation
 
int RepresentationState
 
bool DirectionalLine
 
vtkActorLineActor
 
vtkPolyDataMapperLineMapper
 
vtkLineSourceLineSource
 
vtkActor ** Handle
 
vtkPolyDataMapper ** HandleMapper
 
vtkPolyDataAlgorithm ** HandleGeometry
 
vtkPropertyEndPointProperty
 
vtkPropertySelectedEndPointProperty
 
vtkPropertyEndPoint2Property
 
vtkPropertySelectedEndPoint2Property
 
vtkPropertyLineProperty
 
vtkPropertySelectedLineProperty
 
int Tolerance
 
int ClampToBounds
 
double StartP1 [3]
 
double StartP2 [3]
 
double StartLineHandle [3]
 
double Length
 
double LastEventPosition [3]
 
vtkBoxBoundingBox
 
int InitializedDisplayPosition
 
vtkTypeBool DistanceAnnotationVisibility
 
char * DistanceAnnotationFormat
 
vtkFollowerTextActor
 
vtkPolyDataMapperTextMapper
 
vtkVectorTextTextInput
 
double Distance
 
bool AnnotationTextScaleInitialized
 
vtkCellPickerLinePicker
 
- 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 vtkLineWidget2

This class is a concrete representation for the vtkLineWidget2. It represents a straight line with three handles: one at the beginning and ending of the line, and one used to translate the line. Through interaction with the widget, the line representation can be arbitrarily placed in the 3D space.

To use this representation, you normally specify the position of the two end points (either in world or display coordinates). The PlaceWidget() method is also used to initially position the representation.

Warning
This class, and vtkLineWidget2, are next generation VTK widgets. An earlier version of this functionality was defined in the class vtkLineWidget.
See also
vtkLineWidget2 vtkLineWidget

Definition at line 58 of file vtkLineRepresentation.h.

Member Typedef Documentation

◆ Superclass

Standard methods for the class.

Definition at line 70 of file vtkLineRepresentation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
Outside 
OnP1 
OnP2 
TranslatingP1 
TranslatingP2 
OnLine 
Scaling 

Definition at line 199 of file vtkLineRepresentation.h.

◆ anonymous enum

anonymous enum
Enumerator
RestrictNone 
RestrictToX 
RestrictToY 
RestrictToZ 

Definition at line 311 of file vtkLineRepresentation.h.

Constructor & Destructor Documentation

◆ vtkLineRepresentation()

vtkLineRepresentation::vtkLineRepresentation ( )
protected

◆ ~vtkLineRepresentation()

vtkLineRepresentation::~vtkLineRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkLineRepresentation* vtkLineRepresentation::New ( )
static

Instantiate the class.

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkLineRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkWidgetRepresentation.

◆ NewInstance()

vtkLineRepresentation* vtkLineRepresentation::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetPoint1WorldPosition() [1/2]

void vtkLineRepresentation::GetPoint1WorldPosition ( double  pos[3])

Methods to Set/Get the coordinates of the two points defining this representation.

Note that methods are available for both display and world coordinates.

◆ GetPoint1WorldPosition() [2/2]

double* vtkLineRepresentation::GetPoint1WorldPosition ( )

◆ GetPoint1DisplayPosition() [1/2]

void vtkLineRepresentation::GetPoint1DisplayPosition ( double  pos[3])

◆ GetPoint1DisplayPosition() [2/2]

double* vtkLineRepresentation::GetPoint1DisplayPosition ( )

◆ SetPoint1WorldPosition()

void vtkLineRepresentation::SetPoint1WorldPosition ( double  pos[3])

◆ SetPoint1DisplayPosition()

void vtkLineRepresentation::SetPoint1DisplayPosition ( double  pos[3])

◆ GetPoint2DisplayPosition() [1/2]

void vtkLineRepresentation::GetPoint2DisplayPosition ( double  pos[3])

◆ GetPoint2DisplayPosition() [2/2]

double* vtkLineRepresentation::GetPoint2DisplayPosition ( )

◆ GetPoint2WorldPosition() [1/2]

void vtkLineRepresentation::GetPoint2WorldPosition ( double  pos[3])

◆ GetPoint2WorldPosition() [2/2]

double* vtkLineRepresentation::GetPoint2WorldPosition ( )

◆ SetPoint2WorldPosition()

void vtkLineRepresentation::SetPoint2WorldPosition ( double  pos[3])

◆ SetPoint2DisplayPosition()

void vtkLineRepresentation::SetPoint2DisplayPosition ( double  pos[3])

◆ SetHandleRepresentation()

void vtkLineRepresentation::SetHandleRepresentation ( vtkPointHandleRepresentation3D handle)

This method is used to specify the type of handle representation to use for the three internal vtkHandleWidgets within vtkLineWidget2.

To use this method, create a dummy vtkHandleWidget (or subclass), and then invoke this method with this dummy. Then the vtkLineRepresentation uses this dummy to clone three vtkHandleWidgets of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkLineWidget2.)

◆ InstantiateHandleRepresentation()

void vtkLineRepresentation::InstantiateHandleRepresentation ( )

◆ GetPoint1Representation()

virtual vtkPointHandleRepresentation3D* vtkLineRepresentation::GetPoint1Representation ( )
virtual

Get the three handle representations used for the vtkLineWidget2.

◆ GetPoint2Representation()

virtual vtkPointHandleRepresentation3D* vtkLineRepresentation::GetPoint2Representation ( )
virtual

◆ GetLineHandleRepresentation()

virtual vtkPointHandleRepresentation3D* vtkLineRepresentation::GetLineHandleRepresentation ( )
virtual

◆ GetEndPointProperty()

virtual vtkProperty* vtkLineRepresentation::GetEndPointProperty ( )
virtual

Get the end-point (sphere) properties.

The properties of the end-points when selected and unselected can be manipulated.

◆ GetSelectedEndPointProperty()

virtual vtkProperty* vtkLineRepresentation::GetSelectedEndPointProperty ( )
virtual

◆ GetEndPoint2Property()

virtual vtkProperty* vtkLineRepresentation::GetEndPoint2Property ( )
virtual

Get the end-point (sphere) properties.

The properties of the end-points when selected and unselected can be manipulated.

◆ GetSelectedEndPoint2Property()

virtual vtkProperty* vtkLineRepresentation::GetSelectedEndPoint2Property ( )
virtual

◆ GetLineProperty()

virtual vtkProperty* vtkLineRepresentation::GetLineProperty ( )
virtual

Get the line properties.

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

◆ GetSelectedLineProperty()

virtual vtkProperty* vtkLineRepresentation::GetSelectedLineProperty ( )
virtual

◆ SetTolerance()

virtual void vtkLineRepresentation::SetTolerance ( int  )
virtual

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the line or end point to be active.

◆ GetTolerance()

virtual int vtkLineRepresentation::GetTolerance ( )
virtual

◆ SetResolution()

void vtkLineRepresentation::SetResolution ( int  res)

Set/Get the resolution (number of subdivisions) of the line.

A line with resolution greater than one is useful when points along the line are desired; e.g., generating a rake of streamlines.

◆ GetResolution()

int vtkLineRepresentation::GetResolution ( )

◆ GetPolyData()

void vtkLineRepresentation::GetPolyData ( vtkPolyData pd)

Retrieve the polydata (including points) that defines the line.

The polydata consists of n+1 points, where n is the resolution of the line. These point values are guaranteed to be up-to-date whenever any one of the three handles are moved. To use this method, the user provides the vtkPolyData as an input argument, and the points and polyline are copied into it.

◆ PlaceWidget()

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

These are methods that satisfy vtkWidgetRepresentation's API.

◆ BuildRepresentation()

void vtkLineRepresentation::BuildRepresentation ( )
overridevirtual

◆ ComputeInteractionState()

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

Reimplemented from vtkWidgetRepresentation.

◆ StartWidgetInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ WidgetInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ GetBounds()

double* vtkLineRepresentation::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.

◆ GetActors()

void vtkLineRepresentation::GetActors ( vtkPropCollection pc)
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkLineRepresentation::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 vtkLineRepresentation::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 vtkLineRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport )
overridevirtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

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

The interaction state may be set from a widget (e.g., vtkLineWidget2) 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 vtkLineRepresentation::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 vtkLineRepresentation::GetRepresentationState ( )
virtual

◆ SetDirectionalLine()

void vtkLineRepresentation::SetDirectionalLine ( bool  val)

Sets the representation to be a directional line with point 1 represented as a cone.

◆ GetDirectionalLine()

virtual bool vtkLineRepresentation::GetDirectionalLine ( )
virtual

◆ DirectionalLineOn()

virtual void vtkLineRepresentation::DirectionalLineOn ( )
virtual

◆ DirectionalLineOff()

virtual void vtkLineRepresentation::DirectionalLineOff ( )
virtual

◆ GetMTime()

vtkMTimeType vtkLineRepresentation::GetMTime ( )
overridevirtual

Overload the superclasses' GetMTime() because internal classes are used to keep the state of the representation.

Reimplemented from vtkObject.

◆ SetRenderer()

void vtkLineRepresentation::SetRenderer ( vtkRenderer ren)
overridevirtual

Overridden to set the rendererer on the internal representations.

Reimplemented from vtkWidgetRepresentation.

◆ SetDistanceAnnotationVisibility()

virtual void vtkLineRepresentation::SetDistanceAnnotationVisibility ( vtkTypeBool  )
virtual

Show the distance between the points.

◆ GetDistanceAnnotationVisibility()

virtual vtkTypeBool vtkLineRepresentation::GetDistanceAnnotationVisibility ( )
virtual

◆ DistanceAnnotationVisibilityOn()

virtual void vtkLineRepresentation::DistanceAnnotationVisibilityOn ( )
virtual

◆ DistanceAnnotationVisibilityOff()

virtual void vtkLineRepresentation::DistanceAnnotationVisibilityOff ( )
virtual

◆ SetDistanceAnnotationFormat()

virtual void vtkLineRepresentation::SetDistanceAnnotationFormat ( const char *  )
virtual

Specify the format to use for labelling the line.

Note that an empty string results in no label, or a format string without a "%" character will not print the angle value.

◆ GetDistanceAnnotationFormat()

virtual char* vtkLineRepresentation::GetDistanceAnnotationFormat ( )
virtual

◆ SetDistanceAnnotationScale() [1/2]

void vtkLineRepresentation::SetDistanceAnnotationScale ( double  x,
double  y,
double  z 
)
inline

Scale text (font size along each dimension).

Definition at line 276 of file vtkLineRepresentation.h.

◆ SetDistanceAnnotationScale() [2/2]

virtual void vtkLineRepresentation::SetDistanceAnnotationScale ( double  scale[3])
virtual

◆ GetDistanceAnnotationScale()

virtual double* vtkLineRepresentation::GetDistanceAnnotationScale ( )
virtual

◆ GetDistance()

double vtkLineRepresentation::GetDistance ( )

Get the distance between the points.

◆ SetLineColor()

void vtkLineRepresentation::SetLineColor ( double  r,
double  g,
double  b 
)

Convenience method to set the line color.

Ideally one should use GetLineProperty()->SetColor().

◆ GetDistanceAnnotationProperty()

virtual vtkProperty* vtkLineRepresentation::GetDistanceAnnotationProperty ( )
virtual

Get the distance annotation property.

◆ GetTextActor()

virtual vtkFollower* vtkLineRepresentation::GetTextActor ( )
virtual

Get the text actor.

◆ SetRestrictFlag()

void vtkLineRepresentation::SetRestrictFlag ( int  restrict_flag)

Set if translations should be restricted to one of the axes (disabled if RestrictNone is specified).

◆ CreateDefaultProperties()

void vtkLineRepresentation::CreateDefaultProperties ( )
protected

◆ ClampPosition()

void vtkLineRepresentation::ClampPosition ( double  x[3])
protected

◆ HighlightPoint()

void vtkLineRepresentation::HighlightPoint ( int  ptId,
int  highlight 
)
protected

◆ HighlightLine()

void vtkLineRepresentation::HighlightLine ( int  highlight)
protected

◆ InBounds()

int vtkLineRepresentation::InBounds ( double  x[3])
protected

◆ SizeHandles()

void vtkLineRepresentation::SizeHandles ( )
protected

Member Data Documentation

◆ HandleRepresentation

vtkPointHandleRepresentation3D* vtkLineRepresentation::HandleRepresentation
protected

Definition at line 330 of file vtkLineRepresentation.h.

◆ Point1Representation

vtkPointHandleRepresentation3D* vtkLineRepresentation::Point1Representation
protected

Definition at line 331 of file vtkLineRepresentation.h.

◆ Point2Representation

vtkPointHandleRepresentation3D* vtkLineRepresentation::Point2Representation
protected

Definition at line 332 of file vtkLineRepresentation.h.

◆ LineHandleRepresentation

vtkPointHandleRepresentation3D* vtkLineRepresentation::LineHandleRepresentation
protected

Definition at line 333 of file vtkLineRepresentation.h.

◆ RepresentationState

int vtkLineRepresentation::RepresentationState
protected

Definition at line 336 of file vtkLineRepresentation.h.

◆ DirectionalLine

bool vtkLineRepresentation::DirectionalLine
protected

Definition at line 337 of file vtkLineRepresentation.h.

◆ LineActor

vtkActor* vtkLineRepresentation::LineActor
protected

Definition at line 340 of file vtkLineRepresentation.h.

◆ LineMapper

vtkPolyDataMapper* vtkLineRepresentation::LineMapper
protected

Definition at line 341 of file vtkLineRepresentation.h.

◆ LineSource

vtkLineSource* vtkLineRepresentation::LineSource
protected

Definition at line 342 of file vtkLineRepresentation.h.

◆ Handle

vtkActor** vtkLineRepresentation::Handle
protected

Definition at line 345 of file vtkLineRepresentation.h.

◆ HandleMapper

vtkPolyDataMapper** vtkLineRepresentation::HandleMapper
protected

Definition at line 346 of file vtkLineRepresentation.h.

◆ HandleGeometry

vtkPolyDataAlgorithm** vtkLineRepresentation::HandleGeometry
protected

Definition at line 347 of file vtkLineRepresentation.h.

◆ EndPointProperty

vtkProperty* vtkLineRepresentation::EndPointProperty
protected

Definition at line 351 of file vtkLineRepresentation.h.

◆ SelectedEndPointProperty

vtkProperty* vtkLineRepresentation::SelectedEndPointProperty
protected

Definition at line 352 of file vtkLineRepresentation.h.

◆ EndPoint2Property

vtkProperty* vtkLineRepresentation::EndPoint2Property
protected

Definition at line 353 of file vtkLineRepresentation.h.

◆ SelectedEndPoint2Property

vtkProperty* vtkLineRepresentation::SelectedEndPoint2Property
protected

Definition at line 354 of file vtkLineRepresentation.h.

◆ LineProperty

vtkProperty* vtkLineRepresentation::LineProperty
protected

Definition at line 355 of file vtkLineRepresentation.h.

◆ SelectedLineProperty

vtkProperty* vtkLineRepresentation::SelectedLineProperty
protected

Definition at line 356 of file vtkLineRepresentation.h.

◆ Tolerance

int vtkLineRepresentation::Tolerance
protected

Definition at line 360 of file vtkLineRepresentation.h.

◆ ClampToBounds

int vtkLineRepresentation::ClampToBounds
protected

Definition at line 363 of file vtkLineRepresentation.h.

◆ StartP1

double vtkLineRepresentation::StartP1[3]
protected

Definition at line 371 of file vtkLineRepresentation.h.

◆ StartP2

double vtkLineRepresentation::StartP2[3]
protected

Definition at line 372 of file vtkLineRepresentation.h.

◆ StartLineHandle

double vtkLineRepresentation::StartLineHandle[3]
protected

Definition at line 373 of file vtkLineRepresentation.h.

◆ Length

double vtkLineRepresentation::Length
protected

Definition at line 374 of file vtkLineRepresentation.h.

◆ LastEventPosition

double vtkLineRepresentation::LastEventPosition[3]
protected

Definition at line 375 of file vtkLineRepresentation.h.

◆ BoundingBox

vtkBox* vtkLineRepresentation::BoundingBox
protected

Definition at line 378 of file vtkLineRepresentation.h.

◆ InitializedDisplayPosition

int vtkLineRepresentation::InitializedDisplayPosition
protected

Definition at line 384 of file vtkLineRepresentation.h.

◆ DistanceAnnotationVisibility

vtkTypeBool vtkLineRepresentation::DistanceAnnotationVisibility
protected

Definition at line 387 of file vtkLineRepresentation.h.

◆ DistanceAnnotationFormat

char* vtkLineRepresentation::DistanceAnnotationFormat
protected

Definition at line 388 of file vtkLineRepresentation.h.

◆ TextActor

vtkFollower* vtkLineRepresentation::TextActor
protected

Definition at line 390 of file vtkLineRepresentation.h.

◆ TextMapper

vtkPolyDataMapper* vtkLineRepresentation::TextMapper
protected

Definition at line 391 of file vtkLineRepresentation.h.

◆ TextInput

vtkVectorText* vtkLineRepresentation::TextInput
protected

Definition at line 392 of file vtkLineRepresentation.h.

◆ Distance

double vtkLineRepresentation::Distance
protected

Definition at line 393 of file vtkLineRepresentation.h.

◆ AnnotationTextScaleInitialized

bool vtkLineRepresentation::AnnotationTextScaleInitialized
protected

Definition at line 394 of file vtkLineRepresentation.h.

◆ LinePicker

vtkCellPicker* vtkLineRepresentation::LinePicker
protected

Definition at line 396 of file vtkLineRepresentation.h.


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