Implicit function for a MultiPlane. More...
#include <ImplicitFunction.h>
Public Types | |
| using | Scalar = viskores::FloatDefault |
| using | Vector = viskores::Vec< Scalar, 3 > |
Public Member Functions | |
| MultiPlane ()=default | |
| template<viskores::IdComponent SrcMaxPlanes> | |
| MultiPlane (const MultiPlane< SrcMaxPlanes > &src) | |
| template<viskores::IdComponent SrcMaxPlanes> | |
| MultiPlane & | operator= (const MultiPlane< SrcMaxPlanes > &src) |
| void | AddPlane (const Vector &origin, const Vector &normal) |
| viskores::Plane | GetPlane (int idx) |
| viskores::VecVariable< viskores::Plane, MaxNumPlanes > | GetPlanes () const |
| Scalar | Value (const Vector &point) const |
| Evaluate the value of the implicit function. More... | |
| Vector | Gradient (const Vector &point) const |
| Evaluate the gradient of the implicit function. More... | |
Private Attributes | |
| viskores::VecVariable< viskores::Plane, MaxNumPlanes > | Planes |
Detailed Description
template<viskores::IdComponent MaxNumPlanes>
class viskores::MultiPlane< MaxNumPlanes >
Implicit function for a MultiPlane.
A MultiPlane contains multiple planes. Each plane is defined by a point and a normal to the plane. MaxNumPlanes specifies the maximum number of planes it can hold. We can assign another MultiPlane with a smaller number of planes to the current MultiPlane.
Member Typedef Documentation
◆ Scalar
| using viskores::MultiPlane< MaxNumPlanes >::Scalar = viskores::FloatDefault |
◆ Vector
| using viskores::MultiPlane< MaxNumPlanes >::Vector = viskores::Vec<Scalar, 3> |
Constructor & Destructor Documentation
◆ MultiPlane() [1/2]
|
default |
◆ MultiPlane() [2/2]
|
inline |
Member Function Documentation
◆ AddPlane()
|
inline |
◆ GetPlane()
|
inline |
◆ GetPlanes()
|
inline |
◆ Gradient()
|
inline |
Evaluate the gradient of the implicit function.
The Gradient() method for an implicit function takes a viskores::Vec3f and returns a viskores::Vec3f representing the pointing direction from the implicit function's shape. Gradient calculations are more object shape specific. It is advised to look at the individual shape implementations for specific implicit functions.
◆ operator=()
|
inline |
◆ Value()
|
inline |
Evaluate the value of the implicit function.
The Value() method for an implicit function takes a viskores::Vec3f and returns a viskores::FloatDefault representing the orientation of the point with respect to the implicit function's shape. Negative scalar values represent vector points inside of the implicit function's shape. Positive scalar values represent vector points outside the implicit function's shape. Zero values represent vector points that lie on the surface of the implicit function.
Member Data Documentation
◆ Planes
|
private |
The documentation for this class was generated from the following file:
