Dtk_Drawing Class Reference

This is the drawing class.
It basically contains a Dtk_View array. More...

Inheritance diagram for Dtk_Drawing:

Public Member Functions
virtual Dtk_ErrorStatus	_Store (void *)
Dtk_ErrorStatus	AddOrigin (const Dtk_pnt &origin)
	Internal use only. More...
Dtk_ErrorStatus	AddView (const Dtk_ViewPtr &inView, const Dtk_pnt &inOrigin)
	Adds a view into the drawing. More...
Dtk_ErrorStatus	AddView (const Dtk_ViewPtr &inViewtoBeAdded)
	Adds a view into the drawing. More...
Dtk_Int32	DtkDynamicType (const Dtk_Int32 &inId)
	Retrieves the dynamic entity type. More...
int	DtkDynamicType (const int &inId)
virtual void	dump (FILE *file=stdout)
Dtk_InfoPtr	get_info () const
type_detk	get_type_detk () const
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
Dtk_Size_t	GetNumOrigins () const
	Retrieves the origin points number - read only -. More...
Dtk_Size_t	GetNumViews () const
	Retrieves the views number - read only -. More...
Dtk_pnt &	GetOrigin (const Dtk_Size_t &inPos)
	Retrieves the origin Dtk_pnt - get/set -. More...
const Dtk_pnt &	GetOrigin (const Dtk_Size_t &inPos) const
	Retrieves the ith origin Dtk_pnt - read only -. More...
virtual Dtk_Size_t	GetSize () const
Dtk_ViewPtr &	GetView (const Dtk_Size_t &inPos)
	Retrieves the ith Dtk_View - get/set -. More...
const Dtk_ViewPtr &	GetView (const Dtk_Size_t &inPos) const
	Retrieves the ith Dtk_View - read only -. More...
Dtk_Double64 &	Height ()
	Retrieves the drawing height - get/set -. More...
const Dtk_Double64 &	Height () const
	Retrieves the drawing height - read only -. More...
Dtk_InfoPtr &	info ()
virtual void	PrepareTransfo ()
	SetAsDeprecated ("2025.4", "Please remove calls to this function, it will always return 0.") Dtk_Size_t GetNum2dEntities() const
	Retrieves the 2D entities number - read only -. More...
	SetAsDeprecated ("2025.4", "Please remove calls to this function, it will always return a null object.") const Dtk_2dEntityPtr &Get2dEntity(const Dtk_Size_t &inPos) const
	Retrieves the ith 2D entity - read only -. More...
	SetAsDeprecated ("2025.4", "Please remove calls to this function, it will always return a null object.") Dtk_2dEntityPtr &Get2dEntity(const Dtk_Size_t &inPos)
	Retrieves the 2D entity - get/set -. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...
Dtk_Double64 &	Width ()
	Retrieves the drawing width - get/set -. More...
const Dtk_Double64 &	Width () const
	Retrieves the drawing width - read only -. More...

Static Public Member Functions
static Dtk_DrawingPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_DrawingPtr	Create (const Dtk_Drawing &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_DrawingPtr	Create (Dtk_Drawing &&in)
	Calls move constructor to allocate a new object. More...
static Dtk_Drawing *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...

Protected Types
enum	{ _typeID = DTK_TYPE_OBJECT }
enum	{ _typeID = DTK_TYPE_ENTITY }
enum	{ _typeID = DTK_TYPE_DRAWING }

Protected Member Functions
void	_copy (const Dtk_Entity &s)
void	_init ()
void	_reset ()

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the drawing class.
It basically contains a Dtk_View array.

See also

Use Dtk_DrawingPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_OBJECT }; 

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_ENTITY };

anonymous enum

anonymous enum

protected

Enumerator
_typeID

          {
          _typeID = DTK_TYPE_DRAWING
     };

Member Function Documentation

_copy()

void Dtk_Entity::_copy ( const Dtk_Entity &  s )

protectedinherited

_init()

void Dtk_Entity::_init ( )

protectedinherited

_reset()

void Dtk_Entity::_reset ( )

protectedinherited

_Store()

virtual Dtk_ErrorStatus Dtk_Entity::_Store ( void *  )

virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, and Dtk_Point.

AddOrigin()

Dtk_ErrorStatus Dtk_Drawing::AddOrigin

(

const Dtk_pnt &

origin

)

Internal use only.

AddView() [1/2]

Dtk_ErrorStatus Dtk_Drawing::AddView	(	const Dtk_ViewPtr &	inView,
		const Dtk_pnt &	inOrigin
	)

Adds a view into the drawing.

Parameters

inView	Dtk_View to be added.
inOrigin	Origin of the view in the Dtk_Drawing.

Returns

DtkNoError if OK

AddView() [2/2]

Dtk_ErrorStatus Dtk_Drawing::AddView

(

const Dtk_ViewPtr &

inViewtoBeAdded

)

Adds a view into the drawing.

Parameters

inViewtoBeAdded

Dtk_View to be added.

Returns

DtkNoError if OK

Create() [1/3]

static Dtk_DrawingPtr Dtk_Drawing::Create ( )

static

Calls default constructor to allocate a new object.

Create() [2/3]

static Dtk_DrawingPtr Dtk_Drawing::Create ( const Dtk_Drawing &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

Create() [3/3]

static Dtk_DrawingPtr Dtk_Drawing::Create ( Dtk_Drawing &&  in )

static

Calls move constructor to allocate a new object.

Parameters

in	Object to move from.

DtkDynamicCast()

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

static

Performs a dynamic cast - doesn't need RTTI -.

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_Drawing::DtkDynamicType

(

const Dtk_Int32 &

inId

)

Retrieves the dynamic entity type.

DtkDynamicType() [2/2]

int Dtk_Entity::DtkDynamicType ( const int &  inId )

virtualinherited

Implements Dtk_Object.

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshSurface, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Constraint, Dtk_ConstraintReference, and Dtk_AxisSystem.

dump()

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

virtualinherited

get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const

inherited

get_type_detk()

type_detk Dtk_Drawing::get_type_detk ( ) const

virtual

Returns

The type of the entity type - DTK_TYPE_DRAWING -

Implements Dtk_Entity.

     {
          return DTK_TYPE_DRAWING;
     }

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

GetNumOrigins()

Dtk_Size_t Dtk_Drawing::GetNumOrigins

(

)

const

Retrieves the origin points number - read only -.

Returns

The origin points number.

GetNumViews()

Dtk_Size_t Dtk_Drawing::GetNumViews

(

)

const

Retrieves the views number - read only -.

Returns

The views number.

GetOrigin() [1/2]

Dtk_pnt& Dtk_Drawing::GetOrigin

(

const Dtk_Size_t &

inPos

)

Retrieves the origin Dtk_pnt - get/set -.

Parameters

inPos

origin Dtk_pnt index.

Returns

the inPos'th origin Dtk_pnt.

See also

GetOrigin(const Dtk_Size_t&) const

GetOrigin() [2/2]

const Dtk_pnt& Dtk_Drawing::GetOrigin

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith origin Dtk_pnt - read only -.

Parameters

inPos

origin Dtk_pnt index.

Returns

the inPos'th origin Dtk_pnt.

See also

GetOrigin(const Dtk_Size_t&)

GetSize()

virtual Dtk_Size_t Dtk_Entity::GetSize ( ) const

virtualinherited

Reimplemented from Dtk_Object.

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, and Dtk_Point.

GetView() [1/2]

Dtk_ViewPtr& Dtk_Drawing::GetView

(

const Dtk_Size_t &

inPos

)

Retrieves the ith Dtk_View - get/set -.

Parameters

inPos

View index.

Returns

the inPos'th Dtk_View.

See also

GetView(const Dtk_Size_t&) const

GetView() [2/2]

const Dtk_ViewPtr& Dtk_Drawing::GetView

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith Dtk_View - read only -.

Parameters

inPos

View index.

Returns

the inPos'th Dtk_View.

See also

GetView(const Dtk_Size_t&)

Height() [1/2]

Dtk_Double64& Dtk_Drawing::Height

(

)

Retrieves the drawing height - get/set -.

Returns

the drawing height.

See also

Height() const

Height() [2/2]

const Dtk_Double64& Dtk_Drawing::Height

(

)

const

Retrieves the drawing height - read only -.

Returns

the drawing height.

See also

Height()

info()

Dtk_InfoPtr& Dtk_Entity::info ( )

inherited

PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

SetAsDeprecated() [1/3]

Dtk_Drawing::SetAsDeprecated	(	"2025.4"	,
		"Please remove calls to this	function,
		it will always return 0."
	)		const

Retrieves the 2D entities number - read only -.

Returns

The 2D entities number.

SetAsDeprecated() [2/3]

Dtk_Drawing::SetAsDeprecated	(	"2025.4"	,
		"Please remove calls to this	function,
		it will always return a null object."
	)		const &

Retrieves the ith 2D entity - read only -.

Parameters

inPos

2D entity index.

Returns

the inPos'th 2D entity.

See also

Get2dEntity(const Dtk_Size_t&)

SetAsDeprecated() [3/3]

Dtk_Drawing::SetAsDeprecated	(	"2025.4"	,
		"Please remove calls to this	function,
		it will always return a null object."
	)		const &

Retrieves the 2D entity - get/set -.

Parameters

inPos

2D entity index.

Returns

the inPos'th 2D entity.

See also

Get2dEntity(const Dtk_Size_t&) const

Transform()

Dtk_ErrorStatus Dtk_Drawing::Transform ( const Dtk_transfo &  inTransfo )

virtual

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Implements Dtk_Entity.

Width() [1/2]

Dtk_Double64& Dtk_Drawing::Width

(

)

Retrieves the drawing width - get/set -.

Returns

the drawing width.

See also

Width() const

Width() [2/2]

const Dtk_Double64& Dtk_Drawing::Width

(

)

const

Retrieves the drawing width - read only -.

Returns

the drawing width.

See also

Width()

Field Documentation

_Private

Dtk_Handle* Dtk_Drawing::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited