Dtk_RenderInfos Class Reference

This is the Dtk_RenderInfos Class.
The Dtk_RenderInfosPtr object is used to store any informations about rendering It contains lighting information and texture information.
. More...

Inheritance diagram for Dtk_RenderInfos:

Public Types
enum	RenderMappingShaderTypeEnum {   Unknown = 0, Default = 1, ArchitecturalAndDesign = 2, PolishedMetal = 3,   SatinatedMetal = 4, BrushedMetal = 5, ClearGlass = 6, ColoredGlass = 7,   FrostedGlass = 8, PolishedPlastic = 9, SoftPlastic = 10, Translucent = 11,   MetallicPaint = 12, CarPaint = 13, SubsurfaceScattering = 14, Diffuse = 15 }

Public Member Functions
void	AddShaderType (const RenderMappingShaderTypeEnum &inShaderType)
	Adds the shader type. More...
Dtk_Int32	DtkDynamicType (const Dtk_Int32 &inId)
	Retrieves the dynamic entity type. More...
virtual int	DtkDynamicType (const int &inId)=0
virtual void	dump (FILE *file=stdout)
Dtk_LightMapPtr	GetLightMap () const
	Returns the render light map. More...
Dtk_string	GetName () const
	Returns the texture name. More...
Dtk_string	GetRenderFilePath () const
	Returns the render file path. More...
RenderMappingShaderTypeEnum	GetShaderType () const
	Returns shader type. More...
virtual Dtk_Size_t	GetSize () const
Dtk_TextureInfosPtr	GetTexture () const
	Returns the render texture. More...
void	SetLightMap (const Dtk_LightMapPtr &inLights)
	Sets the render light map. More...
void	SetName (const Dtk_string &inName)
	Sets the render name. More...
void	SetRenderFilePath (const Dtk_string &inFilePath)
	Sets the render file path. More...
void	SetTexture (const Dtk_TextureInfosPtr &inTexture)
	Sets the render texture information. More...

Static Public Member Functions
static Dtk_RenderInfosPtr	Create (const Dtk_string &inName)
	Creates a Dtk_RenderInfosPtr. More...
static Dtk_RenderInfosPtr	Create (const Dtk_string &inName, const Dtk_LightMapPtr &inLights, const Dtk_TextureInfosPtr &inTexture)
	Creates a Dtk_RenderInfosPtr. More...
static Dtk_RenderInfosPtr	Create (Dtk_RenderInfos const &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_RenderInfos *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...

Protected Types
enum	{ _typeID = DTK_TYPE_OBJECT }
enum	{ _typeID = DTK_TYPE_RENDER }

Protected Member Functions
virtual Dtk_Object *	Clone ()
	Dtk_RenderInfos (const Dtk_RenderInfos &)
	Dtk_RenderInfos (const Dtk_string &inName, const Dtk_LightMapPtr &inLigths, const Dtk_TextureInfosPtr &inTexture)
	Dtk_RenderInfos (Dtk_RenderInfos &&) DTK_NOEXCEPT
virtual	~Dtk_RenderInfos ()
	Destructor. More...

Protected Attributes
std::unique_ptr< Dtk_Handle >	_Private
unsigned long	count_

Detailed Description

This is the Dtk_RenderInfos Class.
The Dtk_RenderInfosPtr object is used to store any informations about rendering It contains lighting information and texture information.
.

See also

Use Dtk_RenderInfosPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_OBJECT }; 

anonymous enum

anonymous enum

protected

Enumerator
_typeID

{ _typeID = DTK_TYPE_RENDER }; 

RenderMappingShaderTypeEnum

enum Dtk_RenderInfos::RenderMappingShaderTypeEnum

Enumerator
Unknown
Default
ArchitecturalAndDesign
PolishedMetal
SatinatedMetal
BrushedMetal
ClearGlass
ColoredGlass
FrostedGlass
PolishedPlastic
SoftPlastic
Translucent
MetallicPaint
CarPaint
SubsurfaceScattering
Diffuse

     {
          Unknown = 0,
          Default = 1,
          ArchitecturalAndDesign = 2,
          PolishedMetal = 3,
          SatinatedMetal = 4,
          BrushedMetal = 5,
          ClearGlass = 6,
          ColoredGlass = 7,
          FrostedGlass = 8,
          PolishedPlastic = 9,
          SoftPlastic = 10,
          Translucent = 11,
          MetallicPaint = 12,
          CarPaint = 13,
          SubsurfaceScattering = 14,
          Diffuse = 15
     };

Constructor & Destructor Documentation

Dtk_RenderInfos() [1/3]

Dtk_RenderInfos::Dtk_RenderInfos ( const Dtk_RenderInfos &  )

protected

See also

Create( Dtk_RenderInfos const& )

Dtk_RenderInfos() [2/3]

Dtk_RenderInfos::Dtk_RenderInfos ( Dtk_RenderInfos &&  )

protected

Dtk_RenderInfos() [3/3]

Dtk_RenderInfos::Dtk_RenderInfos ( const Dtk_string &  inName, const Dtk_LightMapPtr &  inLigths, const Dtk_TextureInfosPtr &  inTexture  )

protected

See also

CreateDtk_LightMap

~Dtk_RenderInfos()

virtual Dtk_RenderInfos::~Dtk_RenderInfos ( )

protectedvirtual

Destructor.

Member Function Documentation

AddShaderType()

void Dtk_RenderInfos::AddShaderType

(

const RenderMappingShaderTypeEnum &

inShaderType

)

Adds the shader type.

Clone()

virtual Dtk_Object* Dtk_RenderInfos::Clone ( )

protectedvirtual

{ return new Dtk_RenderInfos(*this); }

Create() [1/3]

static Dtk_RenderInfosPtr Dtk_RenderInfos::Create ( const Dtk_string &  inName )

static

Creates a Dtk_RenderInfosPtr.

Parameters

[in]

inName

name.

Returns

the constructed Dtk_RenderInfosPtr.

Create() [2/3]

static Dtk_RenderInfosPtr Dtk_RenderInfos::Create ( const Dtk_string &  inName, const Dtk_LightMapPtr &  inLights, const Dtk_TextureInfosPtr &  inTexture  )

static

Creates a Dtk_RenderInfosPtr.

Parameters

[in]	inName	name.
[in]	inLights	light map.
[in]	inTexture	texture.

Returns

the constructed Dtk_RenderInfosPtr.

Create() [3/3]

static Dtk_RenderInfosPtr Dtk_RenderInfos::Create ( Dtk_RenderInfos const &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

DtkDynamicCast()

static Dtk_RenderInfos* Dtk_RenderInfos::DtkDynamicCast ( Dtk_Object *  s )

static

Performs a dynamic cast - doesn't need RTTI -.

    { 
        if (s->DtkDynamicType(_typeID)) return static_cast<Dtk_RenderInfos*>(s); 
        return NULL; 
    } 

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_RenderInfos::DtkDynamicType

(

const Dtk_Int32 &

inId

)

Retrieves the dynamic entity type.

    { 
        if (inId == _typeID) return 1; 
        return Dtk_Object::DtkDynamicType(inId); 
    }

DtkDynamicType() [2/2]

virtual int Dtk_Object::DtkDynamicType ( const int &  inId )

pure virtualinherited

Implemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshPolyline, Dtk_MeshSurface, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Constraint, Dtk_ConstraintReference, Dtk_AxisSystem, Dtk_Preview, Dtk_Entity, Dtk_picture, Dtk_OverrideSet, Dtk_OverrideInfo, Dtk_MainDoc, Dtk_Component, Dtk_Node, Dtk_DocElement, Dtk_Log, and Dtk_Properties.

dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout )

virtualinherited

GetLightMap()

Dtk_LightMapPtr Dtk_RenderInfos::GetLightMap

(

)

const

Returns the render light map.

GetName()

Dtk_string Dtk_RenderInfos::GetName

(

)

const

Returns the texture name.

GetRenderFilePath()

Dtk_string Dtk_RenderInfos::GetRenderFilePath

(

)

const

Returns the render file path.

GetShaderType()

RenderMappingShaderTypeEnum Dtk_RenderInfos::GetShaderType

(

)

const

Returns shader type.

GetSize()

virtual Dtk_Size_t Dtk_Object::GetSize ( ) const

virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh_face, Dtk_mesh, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Entity, and Dtk_Info.

GetTexture()

Dtk_TextureInfosPtr Dtk_RenderInfos::GetTexture

(

)

const

Returns the render texture.

SetLightMap()

void Dtk_RenderInfos::SetLightMap

(

const Dtk_LightMapPtr &

inLights

)

Sets the render light map.

SetName()

void Dtk_RenderInfos::SetName

(

const Dtk_string &

inName

)

Sets the render name.

SetRenderFilePath()

void Dtk_RenderInfos::SetRenderFilePath

(

const Dtk_string &

inFilePath

)

Sets the render file path.

SetTexture()

void Dtk_RenderInfos::SetTexture

(

const Dtk_TextureInfosPtr &

inTexture

)

Sets the render texture information.

Field Documentation

_Private

std::unique_ptr<Dtk_Handle> Dtk_RenderInfos::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited