DATAKIT API  V2025.1
_3dxmlw::WriteParameters Class Reference

This class provides several parameters to tunes 3dxml Writter.
It must be provided to addInstance3D method. More...

Public Member Functions

Dtk_Int32 GetBlankedStatus () const
 Retrieve the Written blanked status. More...
 
Dtk_RGB GetColor () const
 Retrieve the Written color. More...
 
Dtk_Double64 GetCurveThickness () const
 Retrieve the Written curve thickness. More...
 
Dtk_FontLineType GetCurveType () const
 Retrieve the Written curve type. More...
 
void SetBlankedStatus (const Dtk_Int32 inBlanked)
 Sets the blanked status for the written instance node. More...
 
void SetColor (const Dtk_RGB &inColor)
 Sets the color for the written instance node. More...
 
void SetCurveThickness (Dtk_Double64 inCurveThickness)
 Sets the curve thickness for the written instance node. More...
 
void SetCurveType (Dtk_FontLineType inCurveType)
 Sets the curve type for the written instance node. More...
 
 WriteParameters ()
 Base constructor. More...
 
 ~WriteParameters ()
 Destructor. More...
 

Protected Attributes

Dtk_Int32 _Blanked
 
Dtk_RGB _Color
 
Dtk_Double64 _CurveThickness
 
Dtk_FontLineType _CurveType
 

Detailed Description

This class provides several parameters to tunes 3dxml Writter.
It must be provided to addInstance3D method.

//...

Constructor & Destructor Documentation

◆ WriteParameters()

_3dxmlw::WriteParameters::WriteParameters ( )

Base constructor.

24  {
25  }

◆ ~WriteParameters()

_3dxmlw::WriteParameters::~WriteParameters ( )

Destructor.

29  {
30  }

Member Function Documentation

◆ GetBlankedStatus()

Dtk_Int32 _3dxmlw::WriteParameters::GetBlankedStatus ( ) const

Retrieve the Written blanked status.

40  {
41  return _Blanked;
42  }

◆ GetColor()

Dtk_RGB _3dxmlw::WriteParameters::GetColor ( ) const

Retrieve the Written color.

51  {
52  return _Color;
53  }

◆ GetCurveThickness()

Dtk_Double64 _3dxmlw::WriteParameters::GetCurveThickness ( ) const

Retrieve the Written curve thickness.

73  {
74  return _CurveThickness;
75  }

◆ GetCurveType()

Dtk_FontLineType _3dxmlw::WriteParameters::GetCurveType ( ) const

Retrieve the Written curve type.

62  {
63  return _CurveType;
64  }

◆ SetBlankedStatus()

void _3dxmlw::WriteParameters::SetBlankedStatus ( const Dtk_Int32  inBlanked)

Sets the blanked status for the written instance node.

Parameters
[in]inBlanked: blanked status.
35  {
36  _Blanked = inBlanked;
37  }

◆ SetColor()

void _3dxmlw::WriteParameters::SetColor ( const Dtk_RGB inColor)

Sets the color for the written instance node.

Parameters
[in]inColor: color.
46  {
47  _Color = inColor;
48  }

◆ SetCurveThickness()

void _3dxmlw::WriteParameters::SetCurveThickness ( Dtk_Double64  inCurveThickness)

Sets the curve thickness for the written instance node.

Parameters
[in]inCurveThickness: curve thickness.
68  {
69  _CurveThickness = inCurveThickness;
70  }

◆ SetCurveType()

void _3dxmlw::WriteParameters::SetCurveType ( Dtk_FontLineType  inCurveType)

Sets the curve type for the written instance node.

Parameters
[in]inCurvetype: curve type.
57  {
58  _CurveType = inCurveType;
59  }

Field Documentation

◆ _Blanked

Dtk_Int32 _3dxmlw::WriteParameters::_Blanked
protected

◆ _Color

Dtk_RGB _3dxmlw::WriteParameters::_Color
protected

◆ _CurveThickness

Dtk_Double64 _3dxmlw::WriteParameters::_CurveThickness
protected

◆ _CurveType

Dtk_FontLineType _3dxmlw::WriteParameters::_CurveType
protected
_3dxmlw::WriteParameters::_CurveThickness
Dtk_Double64 _CurveThickness
Definition: 3dxmlw.hpp:20
_3dxmlw::WriteParameters::_Color
Dtk_RGB _Color
Definition: 3dxmlw.hpp:19
_3dxmlw::WriteParameters::_CurveType
Dtk_FontLineType _CurveType
Definition: 3dxmlw.hpp:18
DTK_NO_PATTERN
@ DTK_NO_PATTERN
Definition: util_ent_dtk.hpp:44
_3dxmlw::WriteParameters::_Blanked
Dtk_Int32 _Blanked
Definition: 3dxmlw.hpp:17
Dtk_RGB
Definition: dtk_rgb.hpp:7