DATAKIT API  V2025.1
Dtk_Surface Class Referenceabstract

Dtk_Surface is a geometrical entity representing a surface. Some type of surface are unlimited such as plane, conical, cylindrical, extrusion surface. It is an abstract class that cannot be instancied.
It has several utility methods :
. More...

+ Inheritance diagram for Dtk_Surface:

Public Member Functions

virtual Dtk_ErrorStatus _ComputeAnyDerivative (Dtk_Double64 inUvalue, Dtk_Double64 inVvalue, int inUdiff, int inVdiff, Dtk_dir &outdir, int extendtype) const
 
virtual Dtk_ErrorStatus _ComputeMultipleDerivative (Dtk_Double64 inUvalue, Dtk_Double64 inVvalue, int inUmaxdiff, int inVmaxdiff, int inUVdiffsummax, Dtk_dir *outdirs, int extendtype) const
 
Dtk_bool _HasInternalNurbs () const
 
virtual Dtk_ErrorStatus _Store (void *)
 
Dtk_ErrorStatus ComputeBoundingBox (Dtk_pnt &outMin, Dtk_pnt &outMax) const
 Set Surface Parametrisation : Umin = inDomain[0] Umax = inDomain[1] Vmin = inDomain[2] Vmax = inDomain[3]. More...
 
virtual Dtk_ErrorStatus ComputeNormal (const Dtk_Double64 &inUValue, const Dtk_Double64 &inVValue, Dtk_dir &outDir) const
 Compute Normal on UV point. More...
 
virtual Dtk_ErrorStatus ComputeUVPoint (const Dtk_Double64 &inUValue, const Dtk_Double64 &inVValue, Dtk_pnt &outpnt) const =0
 Compute 3D point. More...
 
Dtk_ErrorStatus ComputeUVto3DFirstDerivative (const Dtk_Double64 &inUValue, const Dtk_Double64 &inVValue, const Dtk_dir &inUVFirstDerivative, Dtk_dir &out3DFirstDerivative) const
 Compute 3D first derivative on UV point according to UV derivative. More...
 
Dtk_ErrorStatus ComputeUVto3DSecondDerivative (const Dtk_Double64 &inUValue, const Dtk_Double64 &inVValue, const Dtk_dir &inUVFirstDerivative, const Dtk_dir &inUVSecondDerivative, Dtk_dir &out3DSecondDerivative) const
 Compute 3D second derivative on UV point according to UV derivatives. More...
 
void DeleteCorrespondingNurbs ()
 
int DtkDynamicType (const int &inId)
 
virtual void dump (FILE *file=stdout)
 
Dtk_InfoPtr get_info () const
 
virtual enum type_detk get_type_detk () const =0
 
virtual Dtk_ErrorStatus GetDomain (Dtk_Double64 outDomain[]) const =0
 Get Surface Parametrisation : Umin = outDomain[0] Umax = outDomain[1] Vmin = outDomain[2] Vmax = outDomain[3]. More...
 
const Dtk_IDGetID () const
 Get Internal UniqueID. More...
 
virtual Dtk_Size_t GetSize () const
 
Dtk_ErrorStatus GetTrimUVBox (Dtk_Double64 outTrimValues[]) const
 Get Surface Trim Box : Umin = outTrimValues[0] Umax = outTrimValues[1] Vmin = outTrimValues[2] Vmax = outTrimValues[3]. More...
 
Dtk_InfoPtrinfo ()
 
Dtk_bool IsTrimmed () const
 Return DTK_TRUE if Surface Is trimmed by parameter value. More...
 
virtual Dtk_bool IsUPeriodic () const
 Return DTK_TRUE If Periodic following U parameter. More...
 
virtual Dtk_bool IsVPeriodic () const
 Return DTK_TRUE If Periodic following V parameter. More...
 
virtual void PrepareTransfo ()
 
virtual Dtk_ErrorStatus SetTrimUVBox (Dtk_Double64 inTrimValues[])
 Set Surface Trim Box : Umin = inTrimValues[0] Umax = inTrimValues[1] Vmin = inTrimValues[2] Vmax = inTrimValues[3]. More...
 
virtual Dtk_NurbsSurfacePtr ToNurbs (const Dtk_Double64 *inTrimDomain=NULL) const =0
 Convert a surface into a Nurbs, keeping the parametrisation of the initial surface. More...
 
virtual Dtk_ErrorStatus Transform (const Dtk_transfo &inTransfo)=0
 

Static Public Member Functions

static Dtk_SurfacePtr Create (const Dtk_Surface &s)
 Create Surface by copy. More...
 
static Dtk_SurfaceDtkDynamicCast (Dtk_Object *s)
 

Protected Types

enum  { _typeID = DTK_TYPE_OBJECT }
 
enum  { _typeID = DTK_TYPE_ENTITY }
 
enum  { _typeID = DTK_TYPE_SURFACE }
 

Protected Member Functions

void _copy (const Dtk_Entity &s)
 
void _copy (const Dtk_Object &s)
 
void _init ()
 
void _reset ()
 
virtual Dtk_ObjectClone ()=0
 
 Dtk_Surface ()
 
 Dtk_Surface (const Dtk_Surface &s)
 
virtual ~Dtk_Surface ()
 

Protected Attributes

Dtk_Handle * _Private
 
unsigned long count_
 

Friends

class Dtk_SmartPtr< Dtk_Surface >
 
void PDtk_StoreDataSurface (void *, Dtk_SurfacePtr &)
 

Detailed Description

Dtk_Surface is a geometrical entity representing a surface. Some type of surface are unlimited such as plane, conical, cylindrical, extrusion surface. It is an abstract class that cannot be instancied.
It has several utility methods :
.

  • GetDomain allow you to get the whole definition domain for the surface.
  • SetTrimDomain/GetTrimDomain allow you to specify/get the used domain for the surface.
  • ToNurbs convert the surface into nurbs surface.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 

Constructor & Destructor Documentation

◆ Dtk_Surface() [1/2]

Dtk_Surface::Dtk_Surface ( )
protected

◆ Dtk_Surface() [2/2]

Dtk_Surface::Dtk_Surface ( const Dtk_Surface s)
protected

◆ ~Dtk_Surface()

virtual Dtk_Surface::~Dtk_Surface ( )
protectedvirtual

Member Function Documentation

◆ _ComputeAnyDerivative()

◆ _ComputeMultipleDerivative()

virtual Dtk_ErrorStatus Dtk_Surface::_ComputeMultipleDerivative ( Dtk_Double64  inUvalue,
Dtk_Double64  inVvalue,
int  inUmaxdiff,
int  inVmaxdiff,
int  inUVdiffsummax,
Dtk_dir outdirs,
int  extendtype 
) const
virtual

◆ _copy() [1/2]

void Dtk_Entity::_copy ( const Dtk_Entity s)
protectedinherited

◆ _copy() [2/2]

void Dtk_Object::_copy ( const Dtk_Object s)
protectedinherited

◆ _HasInternalNurbs()

Dtk_bool Dtk_Surface::_HasInternalNurbs ( ) const

◆ _init()

void Dtk_Entity::_init ( )
protectedinherited

◆ _reset()

void Dtk_Entity::_reset ( )
protectedinherited

◆ _Store()

◆ Clone()

◆ ComputeBoundingBox()

Dtk_ErrorStatus Dtk_Surface::ComputeBoundingBox ( Dtk_pnt outMin,
Dtk_pnt outMax 
) const

Set Surface Parametrisation : Umin = inDomain[0] Umax = inDomain[1] Vmin = inDomain[2] Vmax = inDomain[3].

Compute Bounding Box

◆ ComputeNormal()

virtual Dtk_ErrorStatus Dtk_Surface::ComputeNormal ( const Dtk_Double64 inUValue,
const Dtk_Double64 inVValue,
Dtk_dir outDir 
) const
virtual

◆ ComputeUVPoint()

◆ ComputeUVto3DFirstDerivative()

Dtk_ErrorStatus Dtk_Surface::ComputeUVto3DFirstDerivative ( const Dtk_Double64 inUValue,
const Dtk_Double64 inVValue,
const Dtk_dir inUVFirstDerivative,
Dtk_dir out3DFirstDerivative 
) const

Compute 3D first derivative on UV point according to UV derivative.

◆ ComputeUVto3DSecondDerivative()

Dtk_ErrorStatus Dtk_Surface::ComputeUVto3DSecondDerivative ( const Dtk_Double64 inUValue,
const Dtk_Double64 inVValue,
const Dtk_dir inUVFirstDerivative,
const Dtk_dir inUVSecondDerivative,
Dtk_dir out3DSecondDerivative 
) const

Compute 3D second derivative on UV point according to UV derivatives.

◆ Create()

static Dtk_SurfacePtr Dtk_Surface::Create ( const Dtk_Surface s)
static

Create Surface by copy.

◆ DeleteCorrespondingNurbs()

void Dtk_Surface::DeleteCorrespondingNurbs ( )

◆ DtkDynamicCast()

static Dtk_Surface* Dtk_Surface::DtkDynamicCast ( Dtk_Object s)
static

◆ DtkDynamicType()

◆ dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout)
virtualinherited

◆ get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const
inherited

◆ get_type_detk()

◆ GetDomain()

virtual Dtk_ErrorStatus Dtk_Surface::GetDomain ( Dtk_Double64  outDomain[]) const
pure virtual

◆ GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const
inherited

Get Internal UniqueID.

Returns
InternalID

◆ GetSize()

◆ GetTrimUVBox()

Dtk_ErrorStatus Dtk_Surface::GetTrimUVBox ( Dtk_Double64  outTrimValues[]) const

Get Surface Trim Box : Umin = outTrimValues[0] Umax = outTrimValues[1] Vmin = outTrimValues[2] Vmax = outTrimValues[3].

◆ info()

Dtk_InfoPtr& Dtk_Entity::info ( )
inherited

◆ IsTrimmed()

Dtk_bool Dtk_Surface::IsTrimmed ( ) const

Return DTK_TRUE if Surface Is trimmed by parameter value.

◆ IsUPeriodic()

virtual Dtk_bool Dtk_Surface::IsUPeriodic ( ) const
virtual

Return DTK_TRUE If Periodic following U parameter.

Reimplemented in Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_LinearExtrusionSurface, and Dtk_NurbsSurface.

◆ IsVPeriodic()

virtual Dtk_bool Dtk_Surface::IsVPeriodic ( ) const
virtual

Return DTK_TRUE If Periodic following V parameter.

Reimplemented in Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_LinearExtrusionSurface, and Dtk_NurbsSurface.

◆ PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )
virtualinherited

Reimplemented in Dtk_OffsetSurface.

◆ SetTrimUVBox()

virtual Dtk_ErrorStatus Dtk_Surface::SetTrimUVBox ( Dtk_Double64  inTrimValues[])
virtual

Set Surface Trim Box : Umin = inTrimValues[0] Umax = inTrimValues[1] Vmin = inTrimValues[2] Vmax = inTrimValues[3].

Reimplemented in Dtk_StandardRevolutionSurface, and Dtk_RevolutionSurface.

◆ ToNurbs()

virtual Dtk_NurbsSurfacePtr Dtk_Surface::ToNurbs ( const Dtk_Double64 inTrimDomain = NULL) const
pure virtual

◆ Transform()

Friends And Related Function Documentation

◆ Dtk_SmartPtr< Dtk_Surface >

friend class Dtk_SmartPtr< Dtk_Surface >
friend

◆ PDtk_StoreDataSurface

void PDtk_StoreDataSurface ( void *  ,
Dtk_SurfacePtr  
)
friend

Field Documentation

◆ _Private

Dtk_Handle* Dtk_Surface::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
DTK_TYPE_ENTITY
@ DTK_TYPE_ENTITY
Definition: define.h:466
Dtk_Surface::_typeID
@ _typeID
Definition: util_geom_dtk.hpp:760
DTK_TYPE_OBJECT
@ DTK_TYPE_OBJECT
Definition: define.h:464
DTK_TYPE_SURFACE
@ DTK_TYPE_SURFACE
Definition: define.h:114
Dtk_Entity::_typeID
@ _typeID
Definition: util_ent_dtk.hpp:333
Dtk_Object::_typeID
@ _typeID
Definition: dtk_object.hpp:13