Dtk_Frame Class Reference

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

Public Member Functions
void	Clear ()
	Clear elements. More...
Dtk_ErrorStatus	CreateGeometries (Dtk_tab< Dtk_CurvePtr > &outGeoms) const
	Process Related geometries. More...
	Dtk_Frame ()
	Default constructor. More...
	Dtk_Frame (const Dtk_Frame &in)
	Copy constructor. More...
	Dtk_Frame (const Dtk_frame_type &inFrameType, Dtk_tab< Dtk_CurvePtr > inRelatedGeometricalElts)
	Full featured constructor. More...
	Dtk_Frame (Dtk_Frame &&in) DTK_NOEXCEPT
	Move constructor. More...
const Dtk_frame_type &	GetFrameType () const
	Retrieves the Frame Type - Read Only -. More...
Dtk_Frame &	operator= (const Dtk_Frame &in)
	Copy assignment operator. More...
Dtk_Frame &	operator= (Dtk_Frame &&in) DTK_NOEXCEPT
	Move assignment operator. 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 Attributes
Dtk_frame_type	_FrameType
Dtk_tab< Dtk_CurvePtr >	_RelatedGeomElements

Detailed Description

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

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 &

in

)

Copy constructor.

Parameters

in	Object to copy from.

Dtk_Frame() [3/4]

Dtk_Frame::Dtk_Frame

(

Dtk_Frame &&

in

)

Move constructor.

Parameters

s	Object to move from.

Dtk_Frame() [4/4]

Dtk_Frame::Dtk_Frame

(

)

Default constructor.

: _FrameType( DTK_FRAME_TYPE_NONE ) {}

~Dtk_Frame()

Dtk_Frame::~Dtk_Frame

(

)

Destructor.

{}

Member Function Documentation

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 &

in

)

Copy assignment operator.

Parameters

in	Object to copy from.

operator=() [2/2]

Dtk_Frame& Dtk_Frame::operator=

(

Dtk_Frame &&

in

)

Move assignment operator.

Parameters

in	Object to move from.

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