Dtk_Frame Class Reference

This is the frame class.
It's used to gather all frame informations. More...

Public Member Functions
void	Clear ()
	Clear elements. More...
Dtk_ErrorStatus	CreateGeometries (Dtk_tab< Dtk_CurvePtr > &outGeoms) const
	Process Related geometries. More...
	Dtk_Frame ()
	Base constructor. More...
	Dtk_Frame (const Dtk_Frame &s)
	Copy constructor. More...
	Dtk_Frame (const Dtk_frame_type &inFrameType, Dtk_tab< Dtk_CurvePtr > inRelatedGeometricalElts)
	Full featured constructor. More...
	Dtk_Frame (Dtk_Frame &&s) DTK_NOEXCEPT
	\MoveConstructor{s} More...
const Dtk_frame_type &	GetFrameType () const
	Retrieves the Frame Type - Read Only -. More...
Dtk_Frame &	operator= (const Dtk_Frame &inToBeAssigned)
	Assignment Operator. More...
Dtk_Frame &	operator= (Dtk_Frame &&inToBeMoved) DTK_NOEXCEPT
	\MoveOp{inTobeAssigned} More...
	SetAsDeprecated ("2020.2", "Use CreateGeometries(Dtk_tab< Dtk_CurvePtr >& outGeoms) instead") Dtk_ErrorStatus CreateGeometries(Dtk_tab< Geometric_set_select_entity * > &outGeoms) const
	OBSOLETE Process Related geometries into old form geometry. More...
void	SetFrameData (const Dtk_frame_type &inFrameType, Dtk_tab< Dtk_CurvePtr > inRelatedGeomElements)
	Set Frame informations. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the frame. More...
Dtk_ErrorStatus	Translate (const Dtk_dir &inTranslateDir)
	Translates the frame giving a translation vector. More...
	~Dtk_Frame ()
	Destructor. More...

Protected Member Functions
void	_Copy (const Dtk_Frame &s)
void	_Init ()
void	_Reset ()

Protected Attributes
Dtk_frame_type	_FrameType
Dtk_tab< Dtk_CurvePtr >	_RelatedGeomElements

Detailed Description

This is the frame class.
It's used to gather all frame informations.

Constructor & Destructor Documentation

Dtk_Frame() [1/4]

Dtk_Frame::Dtk_Frame	(	const Dtk_frame_type &	inFrameType,
		Dtk_tab< Dtk_CurvePtr >	inRelatedGeometricalElts
	)

Full featured constructor.

Parameters

inFrameType	Frame Type.
inRelatedGeometricalElts	Geometries representing the frame.

          : _FrameType( inFrameType ), _RelatedGeomElements( std::move( inRelatedGeometricalElts ) ) { }

Dtk_Frame() [2/4]

Dtk_Frame::Dtk_Frame

(

const Dtk_Frame &

s

)

Copy constructor.

Parameters

s	Object to copy.

: _FrameType( s._FrameType ), _RelatedGeomElements( s._RelatedGeomElements ) { }

Dtk_Frame() [3/4]

Dtk_Frame::Dtk_Frame

(

Dtk_Frame &&

s

)

\MoveConstructor{s}

: _FrameType( s._FrameType ), _RelatedGeomElements( std::move( s._RelatedGeomElements ) ) { }

Dtk_Frame() [4/4]

Dtk_Frame::Dtk_Frame

(

)

Base constructor.

    {
        _Init();
    }

~Dtk_Frame()

Dtk_Frame::~Dtk_Frame

(

)

Destructor.

{ _Reset();}

Member Function Documentation

_Copy()

void Dtk_Frame::_Copy ( const Dtk_Frame &  s )

protected

    {
        _FrameType = s._FrameType;
        for( Dtk_Size_t i = 0 ; i < s._RelatedGeomElements.size() ; i++)
        {
            Dtk_CurvePtr c;
            s._RelatedGeomElements[i].Clone(c);
            _RelatedGeomElements.push_back(c);
        }
    }

_Init()

void Dtk_Frame::_Init ( )

protected

    {
        _FrameType = DTK_FRAME_TYPE_NONE;
    }

_Reset()

void Dtk_Frame::_Reset ( )

protected

{}

Clear()

void Dtk_Frame::Clear

(

)

Clear elements.

    {
        _FrameType = DTK_FRAME_TYPE_NONE;
        _RelatedGeomElements.clear();
    }

CreateGeometries()

Dtk_ErrorStatus Dtk_Frame::CreateGeometries

(

Dtk_tab< Dtk_CurvePtr > &

outGeoms

)

const

Process Related geometries.

Returns

Always dtkNoError as success.

GetFrameType()

const Dtk_frame_type& Dtk_Frame::GetFrameType

(

)

const

Retrieves the Frame Type - Read Only -.

Returns

The Frame Type

{return _FrameType;}

operator=() [1/2]

Dtk_Frame& Dtk_Frame::operator=

(

const Dtk_Frame &

inToBeAssigned

)

Assignment Operator.

Parameters

inTobeAssigned

Object to copy.

operator=() [2/2]

Dtk_Frame& Dtk_Frame::operator=

(

Dtk_Frame &&

inToBeMoved

)

\MoveOp{inTobeAssigned}

SetAsDeprecated()

Dtk_Frame::SetAsDeprecated	(	"2020.2"	,
		"Use CreateGeometries(Dtk_tab< Dtk_CurvePtr >& outGeoms) instead"
	)		const &

OBSOLETE Process Related geometries into old form geometry.

Deprecated:

Use CreateGeometries(Dtk_tab< Dtk_CurvePtr >& outGeoms) const method instead.

Returns

Always dtkErrorTypeNotsupported

SetFrameData()

void Dtk_Frame::SetFrameData	(	const Dtk_frame_type &	inFrameType,
		Dtk_tab< Dtk_CurvePtr >	inRelatedGeomElements
	)

Set Frame informations.

Parameters

inFrameType	Frame Type.
inRelatedGeometricalElts	Geometries representing the frame.

    {
        this->_FrameType = inFrameType;
        this->_RelatedGeomElements = std::move( inRelatedGeomElements );
    }

Transform()

Dtk_ErrorStatus Dtk_Frame::Transform

(

const Dtk_transfo &

inTransfo

)

Applies a transformation matrix to the frame.

Parameters

inTransfo

The transformation matrix

Returns

dtkNoError if OK

Translate()

Dtk_ErrorStatus Dtk_Frame::Translate

(

const Dtk_dir &

inTranslateDir

)

Translates the frame giving a translation vector.

Parameters

inTranslateDir

the translation vector

Returns

dtkNoError if OK

Field Documentation

_FrameType

Dtk_frame_type Dtk_Frame::_FrameType

protected

_RelatedGeomElements

Dtk_tab< Dtk_CurvePtr > Dtk_Frame::_RelatedGeomElements

protected