Dtk_Hatching Class Reference

This is the Hatching class. The hatching fills a close area delimited by boundaries (a set of Dtk_Polyline polylines). The first boundary is the outer bounday, following boundaries are inner boundaries. A hatching area can include several Dtk_HatchingPattern patterns (repetition of decorated/styled lines, dots or simple solid coloring). More...

Inheritance diagram for Dtk_Hatching:

Public Member Functions
virtual Dtk_ErrorStatus	_Store (void *)
Dtk_tab< Dtk_PolylinePtr > &	Boundaries ()
	Retrieves the hatching area boundaries as an array(ordered polylines). The first bounday (this->Boundaries[0]) is the outer boundary. 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_tab< Dtk_EntityPtr >	GeneratePatternGeometries (const Dtk_dir &inXRefDir=Dtk_dir(1., 0., 0.), const Dtk_dir &inNormalDir=Dtk_dir(0., 0., 1.))
	Generate Pattern geometries from Dtk_Hatching. More...
Dtk_InfoPtr	get_info () const
type_detk	get_type_detk () const
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
virtual Dtk_Size_t	GetSize () const
Dtk_InfoPtr &	info ()
Dtk_Hatching &	operator= (const Dtk_Hatching &in)
	Copy assignment operator. More...
Dtk_tab< Dtk_HatchingPattern > &	Patterns ()
	Retrieves the hatching area patterns. Patterns describes hatch line presentations (angle, pitch etc...) More...
virtual void	PrepareTransfo ()
void	SetApplyScaleOnPattern (bool inApply=true)
	Specify if applying transform also scales pattern data. Not active by default. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...

Static Public Member Functions
static Dtk_HatchingPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_Hatching *	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_HATCHING }

Protected Member Functions
void	_copy (const Dtk_Entity &s)
void	_init ()
void	_reset ()
virtual Dtk_Object *	Clone ()
	Dtk_Hatching ()
	Dtk_Hatching (const Dtk_Hatching &s)
	~Dtk_Hatching ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the Hatching class. The hatching fills a close area delimited by boundaries (a set of Dtk_Polyline polylines). The first boundary is the outer bounday, following boundaries are inner boundaries. A hatching area can include several Dtk_HatchingPattern patterns (repetition of decorated/styled lines, dots or simple solid coloring).

See also

Use Dtk_HatchingPtr 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_HATCHING
     };

Constructor & Destructor Documentation

Dtk_Hatching() [1/2]

Dtk_Hatching::Dtk_Hatching ( )

protected

See also

Create()

Dtk_Hatching() [2/2]

Dtk_Hatching::Dtk_Hatching ( const Dtk_Hatching &  s )

protected

~Dtk_Hatching()

Dtk_Hatching::~Dtk_Hatching ( )

protected

Destructor.

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.

Boundaries()

Dtk_tab<Dtk_PolylinePtr>& Dtk_Hatching::Boundaries

(

)

Retrieves the hatching area boundaries as an array(ordered polylines). The first bounday (this->Boundaries[0]) is the outer boundary.

Returns

The boundaries

Clone()

virtual Dtk_Object* Dtk_Hatching::Clone ( )

protectedvirtual

Implements Dtk_Entity.

{ return new Dtk_Hatching(*this); }

Create()

static Dtk_HatchingPtr Dtk_Hatching::Create ( )

static

Calls default constructor to allocate a new object.

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_Hatching::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

GeneratePatternGeometries()

Dtk_tab< Dtk_EntityPtr > Dtk_Hatching::GeneratePatternGeometries	(	const Dtk_dir &	inXRefDir = Dtk_dir(1., 0., 0.),
		const Dtk_dir &	inNormalDir = Dtk_dir(0., 0., 1.)
	)

Generate Pattern geometries from Dtk_Hatching.

Parameters

inXRefDir	X reference vector - (1,0,0) by default -.
inNormalDir	Normal vector - (0,0,1) by default -.

Returns

The generated geometries as Dtk_tab< Dtk_EntityPtr >

Remarks

At this moment, we only handle hatching patterns - no point/fill pattern -.

get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const

inherited

get_type_detk()

type_detk Dtk_Hatching::get_type_detk ( ) const

virtual

Implements Dtk_Entity.

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

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.

info()

Dtk_InfoPtr& Dtk_Entity::info ( )

inherited

operator=()

Dtk_Hatching& Dtk_Hatching::operator=

(

const Dtk_Hatching &

in

)

Copy assignment operator.

Parameters

in	Object to copy from.

Patterns()

Dtk_tab<Dtk_HatchingPattern>& Dtk_Hatching::Patterns

(

)

Retrieves the hatching area patterns. Patterns describes hatch line presentations (angle, pitch etc...)

Returns

The patterns as Dtk_HatchingPattern objects

PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

SetApplyScaleOnPattern()

void Dtk_Hatching::SetApplyScaleOnPattern

(

bool

inApply = true

)

Specify if applying transform also scales pattern data. Not active by default.

Parameters

inApply

Boolean denoting if scale shall be applied on pattern data - true by default -.

Transform()

Dtk_ErrorStatus Dtk_Hatching::Transform ( const Dtk_transfo &  inTransfo )

virtual

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Implements Dtk_Entity.

Field Documentation

_Private

Dtk_Handle* Dtk_Hatching::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited