Blob 1.0
Public Member Functions | List of all members
TreeTorus Class Reference

Torus primitive, which generates a thick torus. More...

#include <blobtree.h>

Inheritance diagram for TreeTorus:
TreeNormal Torus TreeElement Circle TreeNode TreeHalfTorus

Public Member Functions

 TreeTorus (const Vector &, const Vector &, const double &, const double &, BlendCompact *)
 Create a torus element. More...
 
 TreeTorus (const double &, const double &, BlendCompact *)
 Create a torus element. More...
 
virtual ~TreeTorus ()
 Destroys a torus primitive.
 
virtual TreeNodeCopy () const
 Creates a deep copy of a circle primitive.
 
int Memory () const
 Compute the size of a node.
 
double Intensity (const Vector &) const
 Computes the intensity at given point in space. More...
 
- Public Member Functions inherited from TreeNormal
 TreeNormal (BlendCompact *=nullptr)
 Creates a skeletal element given a blending function.
 
virtual ~TreeNormal ()
 Destroys a skeletal element.
 
virtual double R (const Vector &) const
 Computes the squared Euclidean distance to the skeleton. More...
 
virtual Vector Gradient (const Vector &) const
 Compute the gradient at a given point. More...
 
virtual void IntensityGradient (const Vector &, double &, Vector &) const
 Compute the field value and the gradient of the field function at a given point in space. More...
 
virtual double K (const Segment &) const
 Compute the Lipschitz constant on a segment. More...
 
virtual double K (const RayStep &) const
 Compute the Lipschitz constant on a segment. More...
 
virtual double K (const Sphere &) const
 Compute the Lipschitz constant inside a sphere. More...
 
- Public Member Functions inherited from TreeElement
 TreeElement (BlendCompact *=nullptr)
 Creates a new element given a blending function.
 
virtual ~TreeElement ()
 Destroys an element. More...
 
double K () const
 Returns the Lipschitz constant of the element. More...
 
double K (const Box &) const
 Returns a local Lipschitz constant within a box domain. More...
 
double K (const Ray &) const
 Returns a local Lipschitz constant along a ray. More...
 
TreeNodeCut (const Box &) const
 Cuts the node to simplify its structure inside a box. More...
 
- Public Member Functions inherited from TreeNode
 TreeNode ()
 Create a virtual node of the Blob-Tree structure.
 
virtual ~TreeNode ()
 Destroys a node.
 
virtual TreeNodeBlend (TreeNode *)
 Insert a blending node that blends the old and the new sub-tree together. More...
 
virtual TreeNodeUnion (TreeNode *)
 Insert a union node that unions the old and the new sub-tree together. More...
 
virtual TreeNodeDifference (TreeNode *)
 Insert a difference node. More...
 
virtual TreeNodeTranslate (const Vector &)
 Insert a translation node. More...
 
virtual TreeNodeRotate (const Matrix &)
 Insert a rotation node. More...
 
virtual TreeNodeScale (const Vector &)
 Insert a scaling node. More...
 
Box GetBox () const
 Return the bounding box of the node.
 
virtual void SetThreshold (const double &)
 Set the threshold value. More...
 
virtual Color GetMaterial (const Vector &, const Vector &=Vector::Null) const
 Gets the color of a node at a point. More...
 
virtual int Nodes () const
 Compute the number of nodes of the sub-tree.
 
virtual int Depth () const
 Compute the dpeth of the sub-tree.
 
virtual Vector Dichotomy (Vector, Vector, double, double, double, const double &=1.0e-4)
 Compute the intersection between the implicit surface and a segment. More...
 

Additional Inherited Members

- Protected Attributes inherited from TreeNode
Box box = Box::Null
 Bounding box of the node.
 
double T = 0.5
 Threshold value.
 
- Static Protected Attributes inherited from TreeNode
static const double Epsilon = 1e-6
 Epsilon value for gradient computation.
 

Detailed Description

Torus primitive, which generates a thick torus.

Contrary to TreeCircle, the field is constant within the volume of the torus. Note that using this class is the same as using a TreeCircle primitive with a BlendR potential function.

Example of how to code a torus primitive:

TreeNode *torus=new TreeTorus(Vector(0.0),Vector(1.0,-1.0,1.0),4.0,1.0,new BlendCubic(2.0,1.0));
Normalized blending functions (1-r2)3.
Definition: blend.h:114
The generic nodes with some pure virtual functions.
Definition: blobtree.h:27
TreeTorus(const Vector &, const Vector &, const double &, const double &, BlendCompact *)
Create a torus element.
Definition: treetorus.cpp:28

,

Constructor & Destructor Documentation

◆ TreeTorus() [1/2]

TreeTorus::TreeTorus ( const Vector c,
const Vector a,
const double &  r,
const double &  s,
BlendCompact blend 
)

Create a torus element.

Parameters
cCenter of the torus.
aAxis of the torus (will be normalized internally).
rMajor radius.
sMinor radius.
blendFalloff function

◆ TreeTorus() [2/2]

TreeTorus::TreeTorus ( const double &  r,
const double &  s,
BlendCompact blend 
)

Create a torus element.

Parameters
rMajor radius.
sMinor radius.
blendFalloff function

Member Function Documentation

◆ Intensity()

double TreeTorus::Intensity ( const Vector p) const
virtual

Computes the intensity at given point in space.

Parameters
pPoint.

Reimplemented from TreeNormal.

Reimplemented in TreeHalfTorus.