_3dxmlw::WriteParameters Class Reference

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

Public Member Functions
void	ClearMaterial ()
	Clears material parameters for the written instance node. More...
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...
Dtk_Double64	GetMaterialAmbient () const
Dtk_RGB	GetMaterialAmbientColor () const
Dtk_Double64	GetMaterialDiffuse () const
Dtk_RGB	GetMaterialDiffuseColor () const
Dtk_string	GetMaterialName () const
Dtk_Double64	GetMaterialReflectivity () const
Dtk_Double64	GetMaterialRefraction () const
Dtk_Double64	GetMaterialSpecular () const
Dtk_RGB	GetMaterialSpecularColor () const
Dtk_Double64	GetMaterialTransparency () const
Dtk_bool	HasMaterial () const
	Returns whether a material was actually set on this instance. 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...
void	SetMaterial (const Dtk_string &inMaterialName, const Dtk_RGB &inAmbientColor=Dtk_RGB(), const Dtk_RGB &inDiffuseColor=Dtk_RGB(), const Dtk_RGB &inSpecularColor=Dtk_RGB(), Dtk_Double64 inAmbient=0, Dtk_Double64 inDiffuse=0, Dtk_Double64 inSpecular=0, Dtk_Double64 inRefraction=0, Dtk_Double64 inTransparency=0, Dtk_Double64 inReflectivity=0)
	Sets material parameters to be applied on the written instance node. More...
	WriteParameters ()
	Default constructor. More...
	~WriteParameters ()
	Destructor. More...

Protected Attributes
Dtk_Int32	_Blanked
Dtk_RGB	_Color
Dtk_Double64	_CurveThickness
Dtk_FontLineType	_CurveType
Dtk_bool	_HasMaterial
Dtk_Double64	_MaterialAmbient
Dtk_RGB	_MaterialAmbientColor
Dtk_Double64	_MaterialDiffuse
Dtk_RGB	_MaterialDiffuseColor
Dtk_string	_MaterialName
Dtk_Double64	_MaterialReflectivity
Dtk_Double64	_MaterialRefraction
Dtk_Double64	_MaterialSpecular
Dtk_RGB	_MaterialSpecularColor
Dtk_Double64	_MaterialTransparency

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

(

)

Default constructor.

               :_Blanked(0)
               , _CurveType( DTK_NO_PATTERN )
               , _Color( Dtk_RGB() )
               , _CurveThickness( 0 )
               , _HasMaterial( false )
               , _MaterialName( L"" )
               , _MaterialAmbient( 0 )
               , _MaterialDiffuse( 0 )
               , _MaterialSpecular( 0 )
               , _MaterialRefraction( 0 )
               , _MaterialTransparency( 0 )
               , _MaterialReflectivity( 0 )
               , _MaterialAmbientColor( Dtk_RGB() )
               , _MaterialDiffuseColor( Dtk_RGB() )
               , _MaterialSpecularColor( Dtk_RGB() )
          {
          }

~WriteParameters()

_3dxmlw::WriteParameters::~WriteParameters

(

)

Destructor.

          {
          }

Member Function Documentation

ClearMaterial()

void _3dxmlw::WriteParameters::ClearMaterial

(

)

Clears material parameters for the written instance node.

          {
               _HasMaterial = false;
               _MaterialName = L"";
          }

GetBlankedStatus()

Dtk_Int32 _3dxmlw::WriteParameters::GetBlankedStatus

(

)

const

Retrieve the Written blanked status.

          {
               return _Blanked;
          }

GetColor()

Dtk_RGB _3dxmlw::WriteParameters::GetColor

(

)

const

Retrieve the Written color.

          {
               return _Color;
          }

GetCurveThickness()

Dtk_Double64 _3dxmlw::WriteParameters::GetCurveThickness

(

)

const

Retrieve the Written curve thickness.

          {
               return _CurveThickness;
          }

GetCurveType()

Dtk_FontLineType _3dxmlw::WriteParameters::GetCurveType

(

)

const

Retrieve the Written curve type.

          {
               return _CurveType;
          }

GetMaterialAmbient()

Dtk_Double64 _3dxmlw::WriteParameters::GetMaterialAmbient

(

)

const

{ return _MaterialAmbient; }

GetMaterialAmbientColor()

Dtk_RGB _3dxmlw::WriteParameters::GetMaterialAmbientColor

(

)

const

{ return _MaterialAmbientColor; }

GetMaterialDiffuse()

Dtk_Double64 _3dxmlw::WriteParameters::GetMaterialDiffuse

(

)

const

{ return _MaterialDiffuse; }

GetMaterialDiffuseColor()

Dtk_RGB _3dxmlw::WriteParameters::GetMaterialDiffuseColor

(

)

const

{ return _MaterialDiffuseColor; }

GetMaterialName()

Dtk_string _3dxmlw::WriteParameters::GetMaterialName

(

)

const

{ return _MaterialName; }

GetMaterialReflectivity()

Dtk_Double64 _3dxmlw::WriteParameters::GetMaterialReflectivity

(

)

const

{ return _MaterialReflectivity; }

GetMaterialRefraction()

Dtk_Double64 _3dxmlw::WriteParameters::GetMaterialRefraction

(

)

const

{ return _MaterialRefraction; }

GetMaterialSpecular()

Dtk_Double64 _3dxmlw::WriteParameters::GetMaterialSpecular

(

)

const

{ return _MaterialSpecular; }

GetMaterialSpecularColor()

Dtk_RGB _3dxmlw::WriteParameters::GetMaterialSpecularColor

(

)

const

{ return _MaterialSpecularColor; }

GetMaterialTransparency()

Dtk_Double64 _3dxmlw::WriteParameters::GetMaterialTransparency

(

)

const

{ return _MaterialTransparency; }

HasMaterial()

Dtk_bool _3dxmlw::WriteParameters::HasMaterial

(

)

const

Returns whether a material was actually set on this instance.

Remarks

Guards against a stale/garbage _HasMaterial flag: a material is only considered present if a non-empty material name was actually provided via SetMaterial().

{ return _HasMaterial && !_MaterialName.is_NULL() && _MaterialName.len() > 0; }

SetBlankedStatus()

void _3dxmlw::WriteParameters::SetBlankedStatus

(

const Dtk_Int32

inBlanked

)

Sets the blanked status for the written instance node.

Parameters

[in]

inBlanked

: blanked status.

          {
               _Blanked = inBlanked;
          }

SetColor()

void _3dxmlw::WriteParameters::SetColor

(

const Dtk_RGB &

inColor

)

Sets the color for the written instance node.

Parameters

[in]

inColor

: color.

          {
               _Color = inColor;
          }

SetCurveThickness()

void _3dxmlw::WriteParameters::SetCurveThickness

(

Dtk_Double64

inCurveThickness

)

Sets the curve thickness for the written instance node.

Parameters

[in]

inCurveThickness

: curve thickness.

          {
               _CurveThickness = inCurveThickness;
          }

SetCurveType()

void _3dxmlw::WriteParameters::SetCurveType

(

Dtk_FontLineType

inCurveType

)

Sets the curve type for the written instance node.

Parameters

[in]

inCurvetype

: curve type.

          {
               _CurveType = inCurveType;
          }

SetMaterial()

void _3dxmlw::WriteParameters::SetMaterial	(	const Dtk_string &	inMaterialName,
		const Dtk_RGB &	inAmbientColor = Dtk_RGB(),
		const Dtk_RGB &	inDiffuseColor = Dtk_RGB(),
		const Dtk_RGB &	inSpecularColor = Dtk_RGB(),
		Dtk_Double64	inAmbient = 0,
		Dtk_Double64	inDiffuse = 0,
		Dtk_Double64	inSpecular = 0,
		Dtk_Double64	inRefraction = 0,
		Dtk_Double64	inTransparency = 0,
		Dtk_Double64	inReflectivity = 0
	)

Sets material parameters to be applied on the written instance node.

          {
               _HasMaterial = true;
               _MaterialName = inMaterialName;
               _MaterialAmbientColor = inAmbientColor;
               _MaterialDiffuseColor = inDiffuseColor;
               _MaterialSpecularColor = inSpecularColor;
               _MaterialAmbient = inAmbient;
               _MaterialDiffuse = inDiffuse;
               _MaterialSpecular = inSpecular;
               _MaterialRefraction = inRefraction;
               _MaterialTransparency = inTransparency;
               _MaterialReflectivity = inReflectivity;
          }

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

_HasMaterial

Dtk_bool _3dxmlw::WriteParameters::_HasMaterial

protected

_MaterialAmbient

Dtk_Double64 _3dxmlw::WriteParameters::_MaterialAmbient

protected

_MaterialAmbientColor

Dtk_RGB _3dxmlw::WriteParameters::_MaterialAmbientColor

protected

_MaterialDiffuse

Dtk_Double64 _3dxmlw::WriteParameters::_MaterialDiffuse

protected

_MaterialDiffuseColor

Dtk_RGB _3dxmlw::WriteParameters::_MaterialDiffuseColor

protected

_MaterialName

Dtk_string _3dxmlw::WriteParameters::_MaterialName

protected

_MaterialReflectivity

Dtk_Double64 _3dxmlw::WriteParameters::_MaterialReflectivity

protected

_MaterialRefraction

Dtk_Double64 _3dxmlw::WriteParameters::_MaterialRefraction

protected

_MaterialSpecular

Dtk_Double64 _3dxmlw::WriteParameters::_MaterialSpecular

protected

_MaterialSpecularColor

Dtk_RGB _3dxmlw::WriteParameters::_MaterialSpecularColor

protected

_MaterialTransparency

Dtk_Double64 _3dxmlw::WriteParameters::_MaterialTransparency

protected