StMLTipParams Struct Reference

Tip parameters structure. More...

#include <multiline.h>

Public Member Functions
	StMLTipParams ()
	Default constructor.
	StMLTipParams (const StMLTipParams &other)
	Copy-constructor.
	StMLTipParams (EnMLTipType _tipType, double _tipParam)
	Constructor by type of tip and parameter of tip. More...
Functions for access to data
EnMLTipType	GetTipType () const
	Type of tip.
double	GetTipParam () const
	Parameter of tip.
Comparison operators
bool	operator== (const StMLTipParams &) const
	Comparison operator.
bool	operator!= (const StMLTipParams &) const
	Comparison operator.

Protected Member Functions
Initialization functions
void	Init (const StMLTipParams &other)
	Initialization by tip parameters structure. More...
void	Init (EnMLTipType _tipType, double _tipParam)
	Initialization by type of tip and parameter of tip. More...
Functions for changing data
bool	ChangeTipType (EnMLTipType othTipType)
	Change type of tip. More...
bool	ChangeTipParam (double othTipParam)
	Change parameter of tip. More...
void	Transform (const MbMatrix &matr)
	Transformation. More...

Friends
class	MbMultiline

Detailed Description

Tip parameters structure.

Multiline tip parameters structure.
Object data can be changed only from MbMultiline.

Constructor & Destructor Documentation

StMLTipParams()

StMLTipParams::StMLTipParams	(	EnMLTipType	_tipType,
		double	_tipParam
	)

Constructor by type of tip and parameter of tip.

Constructor by type of tip and parameter of tip.

Parameters

[in]	_tipType	- Type of tip.
[in]	_tipParam	- Parameter of tip, depends on type of tip: for mtt_UndefTip is undefined, for mtt_LinearTip - distance from the end of multiline to the tip, for mtt_ArcTip - distance from the end of multiline to the vertex of arc of tip, for mtt_PolylineTip - distance from the end of multiline to the vertex of corner of tip, for mtt_ObliqueTip - angle of rotation of normal from the end of multiline (in radians).

Member Function Documentation

Init() [1/2]

void StMLTipParams::Init ( const StMLTipParams &  other )

inlineprotected

Initialization by tip parameters structure.

Initialization.

Init() [2/2]

void StMLTipParams::Init ( EnMLTipType  _tipType, double  _tipParam  )

inlineprotected

Initialization by type of tip and parameter of tip.

Initialization.

Initialization by type of tip and parameter of tip.

Parameters

[in]	_tipType	- Type of tip.
[in]	_tipParam	- Parameter of tip, depends on type of tip: for mtt_UndefTip is undefined, for mtt_LinearTip - distance from the end of multiline to the tip, for mtt_ArcTip - distance from the end of multiline to the vertex of arc of tip, for mtt_PolylineTip - distance from the end of multiline to the vertex of corner of tip, for mtt_ObliqueTip - angle of rotation of normal from the end of multiline (in radians).

ChangeTipType()

bool StMLTipParams::ChangeTipType ( EnMLTipType  othTipType )

inlineprotected

Change type of tip.

Change type of tip (tipType)

Change type of tip of multiline.

Parameters

[in]

othTipType

- New type of tip.

Returns

False if the old value of type coincides with the value of othTipType.

ChangeTipParam()

bool StMLTipParams::ChangeTipParam ( double  othTipParam )

inlineprotected

Change parameter of tip.

Change parameter of tip (tipParam)

Change parameter of tip of multiline.

Parameters

[in]

othTipParam

- New parameter of tip.

Returns

False if the old value of parameter coincides with the value of othTipParam.

Transform()

void StMLTipParams::Transform ( const MbMatrix &  matr )

inlineprotected

Transformation.

Transform an object according to the matrix.

Transform object according to the matrix.

Parameters

[in]

matr

- Transformation matrix.

---

The documentation for this struct was generated from the following file:

• multiline.h