Planes
Introduction
vtkPlanes computes the implicit function and function gradient for a set of planes. The planes must define a convex space.
Methods
evaluateFunction
Evaluate the function at a point x
| Argument | Type | Required | Description |
|---|---|---|---|
x | Yes | The point at which to evaluate the function |
Returns
| Type | Description |
|---|---|
| The function value at the point x |
evaluateGradient
Evaluate the gradient at a point x
| Argument | Type | Required | Description |
|---|---|---|---|
x | Yes | The point at which to evaluate the gradient |
Returns
| Type | Description |
|---|---|
| The gradient at the point x |
extend
Method used to decorate a given object (publicAPI+model) with vtkPlane characteristics.
| Argument | Type | Required | Description |
|---|---|---|---|
publicAPI | Yes | object on which methods will be bounds (public) | |
model | Yes | object on which data structure will be bounds (protected) | |
initialValues | IPlanesInitialValues | No | (default: {}) |
getBounds
Get the bounds of the planes.
Returns
| Type | Description |
|---|---|
| Bounds | The bounds of the planes. |
getNormals
Get the normals of the plane.
Returns
| Type | Description |
|---|---|
| vtkDataArray | The normals of the plane. |
getNumberOfPlanes
Get the number of planes in the set of planes.
getPlane
Get the i-th plane
| Argument | Type | Required | Description |
|---|---|---|---|
i | Number | Yes | The index of the plane to get. |
plane | vtkPlane | No | The vtkPlane instance to fill (optional). |
Returns
| Type | Description |
|---|---|
| vtkPlane | The plane instance at the specified index. If no plane is provided, a new vtkPlane instance will be created. |
getPoints
Get the points of the plane.
Returns
| Type | Description |
|---|---|
| vtkPoints | The points of the plane. |
newInstance
Method used to create a new instance of vtkPlane.
| Argument | Type | Required | Description |
|---|---|---|---|
initialValues | IPlanesInitialValues | No | for pre-setting some of its content |
setBounds
Set the bounds of the planes.
| Argument | Type | Required | Description |
|---|---|---|---|
bounds | Bounds | Yes | The bounds to set. |
Returns
| Type | Description |
|---|---|
| Boolean | true if bounds were set, false if they were already set |
setFrustumPlanes
Set the Frustum planes.
| Argument | Type | Required | Description |
|---|---|---|---|
planes | Array[Vector3] | Yes | The coordinates of the frustum planes. |
setNormals
Set the normals of the plane.
| Argument | Type | Required | Description |
|---|---|---|---|
normals | vtkDataArray | Yes | The normals to set. |
setPoints
Set the points of the plane.
| Argument | Type | Required | Description |
|---|---|---|---|
points | Yes | The points to set. |