VTK  9.5.20251128
vtkMultiLineRepresentation Class Reference

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

#include <vtkMultiLineRepresentation.h>

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

Public Types

enum  {
  MOUSE_OUTSIDE_LINES = 0 , MOUSE_ON_P1 , MOUSE_ON_P2 , TRANSLATING_P1 ,
  TRANSLATING_P2 , MOUSE_ON_LINE , SCALING
}
 
typedef vtkWidgetRepresentation Superclass
 
- Public Types inherited from vtkWidgetRepresentation
enum  Axis {
  NONE = -1 , XAxis = 0 , YAxis = 1 , ZAxis = 2 ,
  Custom = 3
}
 Axis labels. More...
 
typedef vtkProp Superclass
 Standard methods for instances of this class.
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Standard methods for instances of this class.
 
vtkMultiLineRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void GetPolyData (int index, vtkPolyData *pd)
 Retrieve the polydata (including points) that defines the line.
 
vtkLineRepresentationGetLineRepresentation (int index)
 Gets the individual representation of a specific line as a vtkLineRepresentation.
 
vtkMTimeType GetMTime () override
 Overload the superclasses' GetMTime() because internal classes are used to keep the state of the representation.
 
void SetRenderer (vtkRenderer *ren) override
 Overridden to set the rendererer on the internal representations.
 
double GetDistance (int index)
 Get the distance between the points of the line at the provided index.
 
void SetLineColor (double r, double g, double b)
 Convenience method to set the lines color.
 
void GetPoint1WorldPosition (int index, double pos[3]) VTK_FUTURE_CONST
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
double * GetPoint1WorldPosition (int index)
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
void GetPoint1DisplayPosition (int index, double pos[3]) VTK_FUTURE_CONST
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
double * GetPoint1DisplayPosition (int index)
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
void SetPoint1WorldPosition (int index, double pos[3])
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
void SetPoint1DisplayPosition (int index, double pos[3])
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
void GetPoint2DisplayPosition (int index, double pos[3]) VTK_FUTURE_CONST
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
double * GetPoint2DisplayPosition (int index)
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
void GetPoint2WorldPosition (int index, double pos[3]) VTK_FUTURE_CONST
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
double * GetPoint2WorldPosition (int index)
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
void SetPoint2WorldPosition (int index, double pos[3])
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
void SetPoint2DisplayPosition (int index, double pos[3])
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
void SetPoint1WorldPosition (int index, double x, double y, double z)
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
void SetPoint1DisplayPosition (int index, double x, double y, double z)
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
void SetPoint2WorldPosition (int index, double x, double y, double z)
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
void SetPoint2DisplayPosition (int index, double x, double y, double z)
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
vtkDoubleArrayGetPoint1WorldPositions ()
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
vtkDoubleArrayGetPoint2WorldPositions ()
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
vtkDoubleArrayGetPoint1DisplayPositions ()
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
vtkDoubleArrayGetPoint2DisplayPositions ()
 Methods to Set/Get the coordinates of the two points defining a line representation.
 
void SetLineCount (int n)
 Set/Get the number of vtkLineRepresentation in this widget.
 
virtual int GetLineCount ()
 Set/Get the number of vtkLineRepresentation in this widget.
 
virtual vtkPropertyGetEndPointProperty ()
 Get the end-point properties.
 
virtual vtkPropertyGetSelectedEndPointProperty ()
 Get the end-point properties.
 
virtual vtkPropertyGetEndPoint2Property ()
 Get the end-point properties.
 
virtual vtkPropertyGetSelectedEndPoint2Property ()
 Get the end-point properties.
 
virtual vtkPropertyGetLineProperty ()
 Get the lines properties.
 
virtual vtkPropertyGetSelectedLineProperty ()
 Get the lines properties.
 
void SetTolerance (int tol)
 The tolerance representing the distance to a line (in pixels) in which the cursor is considered near enough to a line or end point to be active.
 
virtual int GetTolerance ()
 The tolerance representing the distance to a line (in pixels) in which the cursor is considered near enough to a line or end point to be active.
 
void SetResolution (int res)
 Set/Get the resolution (number of subdivisions, minimum 1) of the line.
 
virtual int GetResolution ()
 Set/Get the resolution (number of subdivisions, minimum 1) of the line.
 
void PlaceWidget (double bounds[6]) override
 These are methods that satisfy vtkWidgetRepresentation's API.
 
void BuildRepresentation () override
 These are methods that satisfy vtkWidgetRepresentation's API.
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 These are methods that satisfy vtkWidgetRepresentation's API.
 
double * GetBounds () override
 These are methods that satisfy vtkWidgetRepresentation's API.
 
virtual void SetInteractionState (int)
 The interaction state may be set from a widget (e.g., vtkMultiLineRepresentation) or other object.
 
virtual void SetRepresentationState (int)
 Sets the visual appearance of the representation based on the state it is in.
 
virtual int GetRepresentationState ()
 Sets the visual appearance of the representation based on the state it is in.
 
void GetActors (vtkPropCollection *pc) override
 Methods supporting the rendering process.
 
void ReleaseGraphicsResources (vtkWindow *window) override
 Methods supporting the rendering process.
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Methods supporting the rendering process.
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 Methods supporting the rendering process.
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Methods supporting the rendering process.
 
void SetDirectionalLine (bool val)
 Sets the representation of each line to be a directional line with point 1 represented as a cone.
 
virtual bool GetDirectionalLine ()
 Sets the representation of each line to be a directional line with point 1 represented as a cone.
 
virtual void DirectionalLineOn ()
 Sets the representation of each line to be a directional line with point 1 represented as a cone.
 
virtual void DirectionalLineOff ()
 Sets the representation of each line to be a directional line with point 1 represented as a cone.
 
void SetInteractionColor (double, double, double)
 Set the widget color, and the color of interactive handles.
 
void SetInteractionColor (double c[3])
 Set the widget color, and the color of interactive handles.
 
void SetForegroundColor (double, double, double)
 Set the widget color, and the color of interactive handles.
 
void SetForegroundColor (double c[3])
 Set the widget color, and the color of interactive handles.
 
- Public Member Functions inherited from vtkWidgetRepresentation
virtual void StartWidgetInteraction (double eventPos[2])
 
virtual void WidgetInteraction (double newEventPos[2])
 
virtual void EndWidgetInteraction (double newEventPos[2])
 
virtual int GetInteractionState ()
 
virtual void Highlight (int highlightOn)
 
double * GetBounds () override
 Methods to make this class behave as a vtkProp.
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp.
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes.
 
void GetActors2D (vtkPropCollection *) override
 
void GetVolumes (vtkPropCollection *) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
 
int RenderOverlay (vtkViewport *viewport) override
 
int RenderOpaqueGeometry (vtkViewport *viewport) 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.
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 
int RenderVolumetricGeometry (vtkViewport *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?
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager.
 
virtual void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager.
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking.
 
virtual void PickingManagedOff ()
 Enable/Disable the use of a manager to process the picking.
 
void SetPickingManaged (bool managed)
 Enable/Disable the use of a manager to process the picking.
 
virtual bool GetPickingManaged ()
 Enable/Disable the use of a manager to process the picking.
 
virtual vtkRendererGetRenderer ()
 Subclasses of vtkWidgetRepresentation must implement these methods.
 
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).
 
virtual double GetPlaceFactor ()
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
 
virtual void SetHandleSize (double)
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).
 
virtual double GetHandleSize ()
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).
 
virtual vtkTypeBool GetNeedToRender ()
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).
 
virtual void SetNeedToRender (vtkTypeBool)
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).
 
virtual void NeedToRenderOn ()
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).
 
virtual void NeedToRenderOff ()
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).
 
vtkWidgetRepresentationNewInstance () const
 Standard methods for instances of this class.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instances of this class.
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked.
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently.
 
virtual void PokeMatrix (vtkMatrix4x4 *matrix)
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys.
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys.
 
virtual vtkTypeBool 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?
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail.
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.
 
virtual void RestoreEstimatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vp)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.
 
void SetRenderTimeMultiplier (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.
 
virtual bool GetSupportsSelection ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp.
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp.
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp.
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp.
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable.
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable.
 
virtual void PickableOn ()
 Set/Get the pickable instance variable.
 
virtual void PickableOff ()
 Set/Get the pickable instance variable.
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable.
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable.
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable.
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable.
 
virtual void SetUseBounds (bool)
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
 
virtual bool GetUseBounds ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
 
virtual void UseBoundsOn ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
 
virtual void UseBoundsOff ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys.
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys.
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *v)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor.
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers.
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,.
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,.
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,.
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,.
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property.
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property.
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkMultiLineRepresentationNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMultiLineRepresentationSafeDownCast (vtkObjectBase *o)
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class.
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class.
 
- 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.
 
static vtkInformationIntegerKeyGENERAL_TEXTURE_UNIT ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.
 
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.
 
static vtkInformationDoubleVectorKeyGENERAL_TEXTURE_TRANSFORM ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instances of this class.
 
 vtkMultiLineRepresentation ()
 
 ~vtkMultiLineRepresentation () override
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation () override
 
vtkVector3d GetWorldPoint (vtkAbstractPicker *picker, double screenPos[2])
 Return the given screen point in world coordinates, based on picked position.
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the widget representation currently belong.
 
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.
 
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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- 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
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a class defining the representation for a vtkMultiLineWidget

This class is a concrete representation for the vtkMultiLineWidget. It represents multiple straight lines with three handles: one at the beginning and ending of each line, and one used to translate each line.

See also
vtkMultiLineWidget
Tests:
vtkMultiLineRepresentation (Tests)

Definition at line 33 of file vtkMultiLineRepresentation.h.

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
MOUSE_OUTSIDE_LINES 
MOUSE_ON_P1 
MOUSE_ON_P2 
TRANSLATING_P1 
TRANSLATING_P2 
MOUSE_ON_LINE 
SCALING 

Definition at line 154 of file vtkMultiLineRepresentation.h.

Constructor & Destructor Documentation

◆ vtkMultiLineRepresentation()

vtkMultiLineRepresentation::vtkMultiLineRepresentation ( )
protected

◆ ~vtkMultiLineRepresentation()

vtkMultiLineRepresentation::~vtkMultiLineRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkMultiLineRepresentation * vtkMultiLineRepresentation::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

Standard methods for instances of this class.

Reimplemented from vtkWidgetRepresentation.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkMultiLineRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkWidgetRepresentation.

◆ NewInstance()

vtkMultiLineRepresentation * vtkMultiLineRepresentation::NewInstance ( ) const

◆ PrintSelf()

void vtkMultiLineRepresentation::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 vtkObjectBase.

◆ GetPoint1WorldPosition() [1/2]

void vtkMultiLineRepresentation::GetPoint1WorldPosition ( int index,
double pos[3] )

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

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

◆ GetPoint1WorldPosition() [2/2]

double * vtkMultiLineRepresentation::GetPoint1WorldPosition ( int index)

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

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

◆ GetPoint1DisplayPosition() [1/2]

void vtkMultiLineRepresentation::GetPoint1DisplayPosition ( int index,
double pos[3] )

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

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

◆ GetPoint1DisplayPosition() [2/2]

double * vtkMultiLineRepresentation::GetPoint1DisplayPosition ( int index)

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

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

◆ SetPoint1WorldPosition() [1/2]

void vtkMultiLineRepresentation::SetPoint1WorldPosition ( int index,
double pos[3] )

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

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

◆ SetPoint1DisplayPosition() [1/2]

void vtkMultiLineRepresentation::SetPoint1DisplayPosition ( int index,
double pos[3] )

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

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

◆ GetPoint2DisplayPosition() [1/2]

void vtkMultiLineRepresentation::GetPoint2DisplayPosition ( int index,
double pos[3] )

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

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

◆ GetPoint2DisplayPosition() [2/2]

double * vtkMultiLineRepresentation::GetPoint2DisplayPosition ( int index)

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

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

◆ GetPoint2WorldPosition() [1/2]

void vtkMultiLineRepresentation::GetPoint2WorldPosition ( int index,
double pos[3] )

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

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

◆ GetPoint2WorldPosition() [2/2]

double * vtkMultiLineRepresentation::GetPoint2WorldPosition ( int index)

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

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

◆ SetPoint2WorldPosition() [1/2]

void vtkMultiLineRepresentation::SetPoint2WorldPosition ( int index,
double pos[3] )

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

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

◆ SetPoint2DisplayPosition() [1/2]

void vtkMultiLineRepresentation::SetPoint2DisplayPosition ( int index,
double pos[3] )

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

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

◆ SetPoint1WorldPosition() [2/2]

void vtkMultiLineRepresentation::SetPoint1WorldPosition ( int index,
double x,
double y,
double z )

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

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

◆ SetPoint1DisplayPosition() [2/2]

void vtkMultiLineRepresentation::SetPoint1DisplayPosition ( int index,
double x,
double y,
double z )

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

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

◆ SetPoint2WorldPosition() [2/2]

void vtkMultiLineRepresentation::SetPoint2WorldPosition ( int index,
double x,
double y,
double z )

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

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

◆ SetPoint2DisplayPosition() [2/2]

void vtkMultiLineRepresentation::SetPoint2DisplayPosition ( int index,
double x,
double y,
double z )

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

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

◆ GetPoint1WorldPositions()

vtkDoubleArray * vtkMultiLineRepresentation::GetPoint1WorldPositions ( )

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

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

◆ GetPoint2WorldPositions()

vtkDoubleArray * vtkMultiLineRepresentation::GetPoint2WorldPositions ( )

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

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

◆ GetPoint1DisplayPositions()

vtkDoubleArray * vtkMultiLineRepresentation::GetPoint1DisplayPositions ( )

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

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

◆ GetPoint2DisplayPositions()

vtkDoubleArray * vtkMultiLineRepresentation::GetPoint2DisplayPositions ( )

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

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

◆ SetLineCount()

void vtkMultiLineRepresentation::SetLineCount ( int n)

Set/Get the number of vtkLineRepresentation in this widget.

◆ GetLineCount()

virtual int vtkMultiLineRepresentation::GetLineCount ( )
virtual

Set/Get the number of vtkLineRepresentation in this widget.

◆ GetEndPointProperty()

virtual vtkProperty * vtkMultiLineRepresentation::GetEndPointProperty ( )
virtual

Get the end-point properties.

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

◆ GetSelectedEndPointProperty()

virtual vtkProperty * vtkMultiLineRepresentation::GetSelectedEndPointProperty ( )
virtual

Get the end-point properties.

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

◆ GetEndPoint2Property()

virtual vtkProperty * vtkMultiLineRepresentation::GetEndPoint2Property ( )
virtual

Get the end-point properties.

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

◆ GetSelectedEndPoint2Property()

virtual vtkProperty * vtkMultiLineRepresentation::GetSelectedEndPoint2Property ( )
virtual

Get the end-point properties.

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

◆ GetLineProperty()

virtual vtkProperty * vtkMultiLineRepresentation::GetLineProperty ( )
virtual

Get the lines properties.

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

◆ GetSelectedLineProperty()

virtual vtkProperty * vtkMultiLineRepresentation::GetSelectedLineProperty ( )
virtual

Get the lines properties.

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

◆ SetTolerance()

void vtkMultiLineRepresentation::SetTolerance ( int tol)

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

The value is clamped between 1 and 100.

◆ GetTolerance()

virtual int vtkMultiLineRepresentation::GetTolerance ( )
virtual

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

The value is clamped between 1 and 100.

◆ SetResolution()

void vtkMultiLineRepresentation::SetResolution ( int res)

Set/Get the resolution (number of subdivisions, minimum 1) 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()

virtual int vtkMultiLineRepresentation::GetResolution ( )
virtual

Set/Get the resolution (number of subdivisions, minimum 1) 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.

◆ GetPolyData()

void vtkMultiLineRepresentation::GetPolyData ( int index,
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 vtkMultiLineRepresentation::PlaceWidget ( double bounds[6])
overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

◆ BuildRepresentation()

void vtkMultiLineRepresentation::BuildRepresentation ( )
overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Implements vtkWidgetRepresentation.

◆ ComputeInteractionState()

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

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

◆ GetBounds()

double * vtkMultiLineRepresentation::GetBounds ( )
overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkProp.

◆ SetInteractionState()

virtual void vtkMultiLineRepresentation::SetInteractionState ( int )
virtual

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

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

This state is usually the same as InteractionState.

◆ GetActors()

void vtkMultiLineRepresentation::GetActors ( vtkPropCollection * pc)
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkMultiLineRepresentation::ReleaseGraphicsResources ( vtkWindow * window)
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkMultiLineRepresentation::RenderOpaqueGeometry ( vtkViewport * viewport)
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkMultiLineRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport * viewport)
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkMultiLineRepresentation::HasTranslucentPolygonalGeometry ( )
overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

◆ SetDirectionalLine()

void vtkMultiLineRepresentation::SetDirectionalLine ( bool val)

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

◆ GetDirectionalLine()

virtual bool vtkMultiLineRepresentation::GetDirectionalLine ( )
virtual

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

◆ DirectionalLineOn()

virtual void vtkMultiLineRepresentation::DirectionalLineOn ( )
virtual

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

◆ DirectionalLineOff()

virtual void vtkMultiLineRepresentation::DirectionalLineOff ( )
virtual

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

◆ GetLineRepresentation()

vtkLineRepresentation * vtkMultiLineRepresentation::GetLineRepresentation ( int index)

Gets the individual representation of a specific line as a vtkLineRepresentation.

◆ GetMTime()

vtkMTimeType vtkMultiLineRepresentation::GetMTime ( )
overridevirtual

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

Reimplemented from vtkObject.

◆ SetRenderer()

void vtkMultiLineRepresentation::SetRenderer ( vtkRenderer * ren)
overridevirtual

Overridden to set the rendererer on the internal representations.

Reimplemented from vtkWidgetRepresentation.

◆ GetDistance()

double vtkMultiLineRepresentation::GetDistance ( int index)

Get the distance between the points of the line at the provided index.

◆ SetLineColor()

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

Convenience method to set the lines color.

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

◆ SetInteractionColor() [1/2]

void vtkMultiLineRepresentation::SetInteractionColor ( double ,
double ,
double  )

Set the widget color, and the color of interactive handles.

◆ SetInteractionColor() [2/2]

void vtkMultiLineRepresentation::SetInteractionColor ( double c[3])
inline

Set the widget color, and the color of interactive handles.

Definition at line 240 of file vtkMultiLineRepresentation.h.

◆ SetForegroundColor() [1/2]

void vtkMultiLineRepresentation::SetForegroundColor ( double ,
double ,
double  )

Set the widget color, and the color of interactive handles.

◆ SetForegroundColor() [2/2]

void vtkMultiLineRepresentation::SetForegroundColor ( double c[3])
inline

Set the widget color, and the color of interactive handles.

Definition at line 242 of file vtkMultiLineRepresentation.h.


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