VTK  9.5.20250715
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#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
35
36VTK_ABI_NAMESPACE_BEGIN
37class vtkRenderer;
38
39class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkPointPlacer : public vtkObject
40{
41public:
46
48
51 vtkTypeMacro(vtkPointPlacer, vtkObject);
52 void PrintSelf(ostream& os, vtkIndent indent) override;
54
63 vtkRenderer* ren, double displayPos[2], double worldPos[3], double worldOrient[9]);
64
72 virtual int ComputeWorldPosition(vtkRenderer* ren, double displayPos[2], double refWorldPos[3],
73 double worldPos[3], double worldOrient[9]);
74
79 virtual int ValidateWorldPosition(double worldPos[3]);
80
84 virtual int ValidateDisplayPosition(vtkRenderer*, double displayPos[2]);
85
90 virtual int ValidateWorldPosition(double worldPos[3], double worldOrient[9]);
91
103 virtual int UpdateWorldPosition(vtkRenderer* ren, double worldPos[3], double worldOrient[9]);
104
113 virtual int UpdateNodeWorldPosition(double worldPos[3], vtkIdType nodePointId);
114
119 virtual int UpdateInternalState() { return 0; }
120
122
126 vtkSetClampMacro(PixelTolerance, int, 1, 100);
127 vtkGetMacro(PixelTolerance, int);
129
131
135 vtkSetClampMacro(WorldTolerance, double, 0.0, VTK_DOUBLE_MAX);
136 vtkGetMacro(WorldTolerance, double);
138
139protected:
141 ~vtkPointPlacer() override;
142
145
146private:
147 vtkPointPlacer(const vtkPointPlacer&) = delete;
148 void operator=(const vtkPointPlacer&) = delete;
149};
150
151VTK_ABI_NAMESPACE_END
152#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:332
#define VTK_DOUBLE_MAX
Definition vtkType.h:171
#define VTK_MARSHALAUTO