PhysicsBasedAnimationToolkit 0.0.10
Cross-platform C++20 library of algorithms and data structures commonly used in computer graphics research on physically-based simulation.
Loading...
Searching...
No Matches
pbat::geometry::sdf::Twist< TScalar > Struct Template Reference

Twist operation around the y axis. More...

#include <UnaryNode.h>

Inheritance diagram for pbat::geometry::sdf::Twist< TScalar >:
pbat::geometry::sdf::UnaryNode

Public Types

using ScalarType = TScalar
 Scalar type.
 

Public Member Functions

 Twist ()=default
 Default constructor.
 
 Twist (ScalarType k_)
 Construct a new Twist object.
 
template<class FSdf>
PBAT_HOST_DEVICE ScalarType Eval (Vec3< ScalarType > const &p, FSdf &&sdf) const
 Evaluate the signed distance function at a point.
 

Public Attributes

ScalarType k {0.2}
 Twist factor.
 

Detailed Description

template<common::CArithmetic TScalar>
struct pbat::geometry::sdf::Twist< TScalar >

Twist operation around the y axis.

Template Parameters
TScalarScalar type

Constructor & Destructor Documentation

◆ Twist()

template<common::CArithmetic TScalar>
pbat::geometry::sdf::Twist< TScalar >::Twist ( ScalarType k_)
inlineexplicit

Construct a new Twist object.

Parameters
k_Twist factor

Member Function Documentation

◆ Eval()

template<common::CArithmetic TScalar>
template<class FSdf>
PBAT_HOST_DEVICE ScalarType pbat::geometry::sdf::Twist< TScalar >::Eval ( Vec3< ScalarType > const & p,
FSdf && sdf ) const
inline

Evaluate the signed distance function at a point.

Template Parameters
FSdfCallable type with signature ScalarType(Vec3<ScalarType> const&)
Parameters
p3 x 1 query point in 3D space
sdfInput SDF
Returns
Signed distance to the twisted shape

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