VTK  9.4.20241112
vtkPointPlacer.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
29#ifndef vtkPointPlacer_h
30#define vtkPointPlacer_h
31
32#include "vtkInteractionWidgetsModule.h" // For export macro
33#include "vtkObject.h"
34
35VTK_ABI_NAMESPACE_BEGIN
36class vtkRenderer;
37
38class VTKINTERACTIONWIDGETS_EXPORT vtkPointPlacer : public vtkObject
39{
40public:
45
47
50 vtkTypeMacro(vtkPointPlacer, vtkObject);
51 void PrintSelf(ostream& os, vtkIndent indent) override;
53
62 vtkRenderer* ren, double displayPos[2], double worldPos[3], double worldOrient[9]);
63
71 virtual int ComputeWorldPosition(vtkRenderer* ren, double displayPos[2], double refWorldPos[3],
72 double worldPos[3], double worldOrient[9]);
73
78 virtual int ValidateWorldPosition(double worldPos[3]);
79
83 virtual int ValidateDisplayPosition(vtkRenderer*, double displayPos[2]);
84
89 virtual int ValidateWorldPosition(double worldPos[3], double worldOrient[9]);
90
102 virtual int UpdateWorldPosition(vtkRenderer* ren, double worldPos[3], double worldOrient[9]);
103
112 virtual int UpdateNodeWorldPosition(double worldPos[3], vtkIdType nodePointId);
113
118 virtual int UpdateInternalState() { return 0; }
119
121
125 vtkSetClampMacro(PixelTolerance, int, 1, 100);
126 vtkGetMacro(PixelTolerance, int);
128
130
134 vtkSetClampMacro(WorldTolerance, double, 0.0, VTK_DOUBLE_MAX);
135 vtkGetMacro(WorldTolerance, double);
137
138protected:
140 ~vtkPointPlacer() override;
141
144
145private:
146 vtkPointPlacer(const vtkPointPlacer&) = delete;
147 void operator=(const vtkPointPlacer&) = delete;
148};
149
150VTK_ABI_NAMESPACE_END
151#endif
a simple class to control print indentation
Definition vtkIndent.h:108
abstract base class for most VTK objects
Definition vtkObject.h:162
Abstract interface to translate 2D display positions to world coordinates.
virtual int ComputeWorldPosition(vtkRenderer *ren, double displayPos[2], double refWorldPos[3], double worldPos[3], double worldOrient[9])
Given a renderer, a display position, and a reference world position, compute the new world position ...
virtual int UpdateInternalState()
Called by the representation to give the placer a chance to update itself.
virtual int UpdateNodeWorldPosition(double worldPos[3], vtkIdType nodePointId)
Give the placer a chance to update the node information, if any.
static vtkPointPlacer * New()
Instantiate this class.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for instances of this class.
~vtkPointPlacer() override
virtual int ValidateDisplayPosition(vtkRenderer *, double displayPos[2])
Given a display position, check the validity of this position.
virtual int ComputeWorldPosition(vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9])
Given a renderer and a display position in pixel coordinates, compute the world position and orientat...
virtual int ValidateWorldPosition(double worldPos[3], double worldOrient[9])
Given a world position and a world orientation, validate it according to the constraints of the place...
virtual int UpdateWorldPosition(vtkRenderer *ren, double worldPos[3], double worldOrient[9])
Given a current renderer, world position and orientation, update them according to the constraints of...
virtual int ValidateWorldPosition(double worldPos[3])
Given a world position check the validity of this position according to the constraints of the placer...
abstract specification for renderers
int vtkIdType
Definition vtkType.h:315
#define VTK_DOUBLE_MAX
Definition vtkType.h:154