StdMeshMaterialTextureUnit Class Reference

#include <StdMeshMaterial.h>

Collaboration diagram for StdMeshMaterialTextureUnit:

Classes
class	Tex
class	TexPtr
struct	Transformation
union	Transformation.__unnamed54__
struct	Transformation.__unnamed54__.Rotate
struct	Transformation.__unnamed54__.RotateAnim
struct	Transformation.__unnamed54__.Scale
struct	Transformation.__unnamed54__.Scroll
struct	Transformation.__unnamed54__.ScrollAnim
struct	Transformation.__unnamed54__.Transform
struct	Transformation.__unnamed54__.WaveXForm

Public Types
enum	TexAddressModeType { AM_Wrap , AM_Clamp , AM_Mirror , AM_Border }
enum	FilteringType { F_None , F_Point , F_Linear , F_Anisotropic }
enum	BlendOpType { BO_Replace , BO_Add , BO_Modulate , BO_AlphaBlend }
enum	BlendOpExType {   BOX_Source1 , BOX_Source2 , BOX_Modulate , BOX_ModulateX2 ,   BOX_ModulateX4 , BOX_Add , BOX_AddSigned , BOX_AddSmooth ,   BOX_Subtract , BOX_BlendDiffuseAlpha , BOX_BlendTextureAlpha , BOX_BlendCurrentAlpha ,   BOX_BlendManual , BOX_Dotproduct , BOX_BlendDiffuseColor }
enum	BlendOpSourceType {   BOS_Current , BOS_Texture , BOS_Diffuse , BOS_Specular ,   BOS_PlayerColor , BOS_Manual }

Public Member Functions
	StdMeshMaterialTextureUnit ()
void	LoadTexture (StdMeshMaterialParserCtx &ctx, const char *texname)
void	Load (StdMeshMaterialParserCtx &ctx)
bool	HasTexture () const
size_t	GetNumTextures () const
const C4TexRef &	GetTexture (unsigned int i) const
bool	HasFrameAnimation () const
bool	HasTexCoordAnimation () const

Public Attributes
StdCopyStrBuf	Name
float	Duration {0.0f}
TexAddressModeType	TexAddressMode {AM_Wrap}
float	TexBorderColor [4]
FilteringType	Filtering [3]
BlendOpExType	ColorOpEx {BOX_Modulate}
BlendOpSourceType	ColorOpSources [2]
float	ColorOpManualFactor {0.0f}
float	ColorOpManualColor1 [3]
float	ColorOpManualColor2 [3]
BlendOpExType	AlphaOpEx {BOX_Modulate}
BlendOpSourceType	AlphaOpSources [2]
float	AlphaOpManualFactor {0.0f}
float	AlphaOpManualAlpha1
float	AlphaOpManualAlpha2
std::vector< Transformation >	Transformations

Detailed Description

Definition at line 192 of file StdMeshMaterial.h.

---

Class Documentation

StdMeshMaterialTextureUnit::Transformation.__unnamed54__

union StdMeshMaterialTextureUnit::Transformation.__unnamed54__

Definition at line 281 of file StdMeshMaterial.h.

Class Members
__unnamed54__	Rotate
__unnamed54__	RotateAnim
__unnamed54__	Scale
__unnamed54__	Scroll
__unnamed54__	ScrollAnim
__unnamed54__	Transform
__unnamed54__	WaveXForm

StdMeshMaterialTextureUnit::Transformation.__unnamed54__.Rotate

struct StdMeshMaterialTextureUnit::Transformation.__unnamed54__.Rotate

Definition at line 285 of file StdMeshMaterial.h.

Class Members
float	Angle

StdMeshMaterialTextureUnit::Transformation.__unnamed54__.RotateAnim

struct StdMeshMaterialTextureUnit::Transformation.__unnamed54__.RotateAnim

Definition at line 286 of file StdMeshMaterial.h.

Class Members
float	RevsPerSec

StdMeshMaterialTextureUnit::Transformation.__unnamed54__.Scale

struct StdMeshMaterialTextureUnit::Transformation.__unnamed54__.Scale

Definition at line 287 of file StdMeshMaterial.h.

Class Members
float	X
float	Y

StdMeshMaterialTextureUnit::Transformation.__unnamed54__.Scroll

struct StdMeshMaterialTextureUnit::Transformation.__unnamed54__.Scroll

Definition at line 283 of file StdMeshMaterial.h.

Class Members
float	X
float	Y

StdMeshMaterialTextureUnit::Transformation.__unnamed54__.ScrollAnim

struct StdMeshMaterialTextureUnit::Transformation.__unnamed54__.ScrollAnim

Definition at line 284 of file StdMeshMaterial.h.

Class Members
float	XSpeed
float	YSpeed

StdMeshMaterialTextureUnit::Transformation.__unnamed54__.Transform

struct StdMeshMaterialTextureUnit::Transformation.__unnamed54__.Transform

Definition at line 288 of file StdMeshMaterial.h.

Class Members
float	M[16]

StdMeshMaterialTextureUnit::Transformation.__unnamed54__.WaveXForm

struct StdMeshMaterialTextureUnit::Transformation.__unnamed54__.WaveXForm

Definition at line 289 of file StdMeshMaterial.h.

Class Members
float	Amplitude
float	Base
float	Frequency
float	Phase
WaveType	Wave
XFormType	XForm

Member Enumeration Documentation

BlendOpExType

enum StdMeshMaterialTextureUnit::BlendOpExType

Enumerator
BOX_Source1
BOX_Source2
BOX_Modulate
BOX_ModulateX2
BOX_ModulateX4
BOX_Add
BOX_AddSigned
BOX_AddSmooth
BOX_Subtract
BOX_BlendDiffuseAlpha
BOX_BlendTextureAlpha
BOX_BlendCurrentAlpha
BOX_BlendManual
BOX_Dotproduct
BOX_BlendDiffuseColor

Definition at line 219 of file StdMeshMaterial.h.

    {
        BOX_Source1,
        BOX_Source2,
        BOX_Modulate,
        BOX_ModulateX2,
        BOX_ModulateX4,
        BOX_Add,
        BOX_AddSigned,
        BOX_AddSmooth,
        BOX_Subtract,
        BOX_BlendDiffuseAlpha,
        BOX_BlendTextureAlpha,
        BOX_BlendCurrentAlpha,
        BOX_BlendManual,
        BOX_Dotproduct,
        BOX_BlendDiffuseColor
    };

BlendOpSourceType

enum StdMeshMaterialTextureUnit::BlendOpSourceType

Enumerator
BOS_Current
BOS_Texture
BOS_Diffuse
BOS_Specular
BOS_PlayerColor
BOS_Manual

Definition at line 238 of file StdMeshMaterial.h.

    {
        BOS_Current,
        BOS_Texture,
        BOS_Diffuse,
        BOS_Specular,
        BOS_PlayerColor, // not specified in ogre, added in OpenClonk
        BOS_Manual
    };

BlendOpType

enum StdMeshMaterialTextureUnit::BlendOpType

Enumerator
BO_Replace
BO_Add
BO_Modulate
BO_AlphaBlend

Definition at line 211 of file StdMeshMaterial.h.

    {
        BO_Replace,
        BO_Add,
        BO_Modulate,
        BO_AlphaBlend
    };

FilteringType

enum StdMeshMaterialTextureUnit::FilteringType

Enumerator
F_None
F_Point
F_Linear
F_Anisotropic

Definition at line 203 of file StdMeshMaterial.h.

    {
        F_None,
        F_Point,
        F_Linear,
        F_Anisotropic
    };

TexAddressModeType

enum StdMeshMaterialTextureUnit::TexAddressModeType

Enumerator
AM_Wrap
AM_Clamp
AM_Mirror
AM_Border

Definition at line 195 of file StdMeshMaterial.h.

    {
        AM_Wrap,
        AM_Clamp,
        AM_Mirror,
        AM_Border
    };

Constructor & Destructor Documentation

StdMeshMaterialTextureUnit()

StdMeshMaterialTextureUnit::StdMeshMaterialTextureUnit

(

)

Definition at line 996 of file StdMeshMaterial.cpp.

{
    TexBorderColor[0] = TexBorderColor[1] = TexBorderColor[2] = 0.0f; TexBorderColor[3] = 1.0f;
    Filtering[0] = Filtering[1] = F_Linear; Filtering[2] = F_Point;
    ColorOpSources[0] = BOS_Current; ColorOpSources[1] = BOS_Texture;
    AlphaOpSources[0] = BOS_Current; AlphaOpSources[1] = BOS_Texture;
    ColorOpManualColor1[0] = ColorOpManualColor1[1] = ColorOpManualColor1[2] = AlphaOpManualAlpha1 = 0.0f;
    ColorOpManualColor2[0] = ColorOpManualColor2[1] = ColorOpManualColor2[2] = AlphaOpManualAlpha2 = 0.0f;
}

References AlphaOpManualAlpha1, AlphaOpManualAlpha2, AlphaOpSources, BOS_Current, BOS_Texture, ColorOpManualColor1, ColorOpManualColor2, ColorOpSources, F_Linear, F_Point, Filtering, and TexBorderColor.

Member Function Documentation

GetNumTextures()

size_t StdMeshMaterialTextureUnit::GetNumTextures ( ) const

inline

Definition at line 339 of file StdMeshMaterial.h.

{ return Textures.size(); }

Referenced by StdMeshInstance::ExecuteAnimation(), and CStdGL::PrepareMaterial().

Here is the caller graph for this function:

GetTexture()

const C4TexRef& StdMeshMaterialTextureUnit::GetTexture ( unsigned int  i ) const

inline

Definition at line 340 of file StdMeshMaterial.h.

{ return Textures[i].pTex->Texture; }

Referenced by CStdGL::PrepareMaterial().

Here is the caller graph for this function:

HasFrameAnimation()

bool StdMeshMaterialTextureUnit::HasFrameAnimation ( ) const

inline

Definition at line 341 of file StdMeshMaterial.h.

{ return Duration > 0; }

References Duration.

Referenced by StdMeshInstance::ExecuteAnimation().

Here is the caller graph for this function:

HasTexCoordAnimation()

bool StdMeshMaterialTextureUnit::HasTexCoordAnimation ( ) const

inline

Definition at line 342 of file StdMeshMaterial.h.

{ return !Transformations.empty(); }

References Transformations.

Referenced by StdMeshInstance::ExecuteAnimation().

Here is the caller graph for this function:

HasTexture()

bool StdMeshMaterialTextureUnit::HasTexture ( ) const

inline

Definition at line 338 of file StdMeshMaterial.h.

{ return !Textures.empty(); }

Load()

void StdMeshMaterialTextureUnit::Load

(

StdMeshMaterialParserCtx &

ctx

)

Definition at line 1018 of file StdMeshMaterial.cpp.

{
    Token token;
    StdCopyStrBuf token_name;
    while ((token = ctx.AdvanceNonEOF(token_name)) == TOKEN_IDTF)
    {
        if (token_name == "texture")
        {
            Textures.clear();
            ctx.AdvanceRequired(token_name, TOKEN_IDTF);
            LoadTexture(ctx, token_name.getData());
        }
        else if (token_name == "anim_texture")
        {
            Textures.clear();
 
            StdCopyStrBuf base_name;
            ctx.AdvanceRequired(base_name, TOKEN_IDTF);
 
            int num_frames;
            if (ctx.AdvanceIntOptional(num_frames))
            {
                const char* data = base_name.getData();
                const char* sep = strrchr(data, '.');
                for (int i = 0; i < num_frames; ++i)
                {
                    StdCopyStrBuf buf;
                    if (sep)
                        buf.Format("%.*s_%d.%s", (int)(sep - data), data, i, sep+1);
                    else
                        buf.Format("%s_%d", data, i);
 
                    LoadTexture(ctx, buf.getData());
                }
 
                Duration = ctx.AdvanceFloat();
            }
            else
            {
                LoadTexture(ctx, base_name.getData());
                while (!ctx.AdvanceFloatOptional(Duration))
                {
                    ctx.AdvanceRequired(token_name, TOKEN_IDTF);
                    LoadTexture(ctx, token_name.getData());
                }
            }
        }
        else if (token_name == "tex_address_mode")
        {
            TexAddressMode = ctx.AdvanceEnum(TexAddressModeEnumerators);
        }
        else if (token_name == "tex_border_colour")
        {
            ctx.AdvanceColor(true, TexBorderColor);
        }
        else if (token_name == "filtering")
        {
            ctx.AdvanceEnums<3, StdMeshMaterialTextureUnit::FilteringType>(FilteringEnumerators, FilteringShortcuts, Filtering);
            if (Filtering[0] == F_None || Filtering[1] == F_None)
                ctx.Error(StdCopyStrBuf("'none' is only valid for the mip filter"));
            if (Filtering[2] == F_Anisotropic)
                ctx.Error(StdCopyStrBuf("'anisotropic' is not a valid mip filter"));
        }
        else if (token_name == "colour_op")
        {
            BlendOpType ColorOp = ctx.AdvanceEnum(BlendOpEnumerators);
            switch (ColorOp)
            {
            case BO_Replace:
                ColorOpEx = BOX_Source1;
                break;
            case BO_Add:
                ColorOpEx = BOX_Add;
                break;
            case BO_Modulate:
                ColorOpEx = BOX_Modulate;
                break;
            case BO_AlphaBlend:
                ColorOpEx = BOX_BlendTextureAlpha;
                break;
            }
 
            ColorOpSources[0] = BOS_Texture;
            ColorOpSources[1] = BOS_Current;
        }
        else if (token_name == "colour_op_ex")
        {
            ColorOpEx = ctx.AdvanceEnum(BlendOpExEnumerators);
            ColorOpSources[0] = ctx.AdvanceEnum(BlendOpSourceEnumerators);
            ColorOpSources[1] = ctx.AdvanceEnum(BlendOpSourceEnumerators);
            if (ColorOpEx == BOX_BlendManual) ColorOpManualFactor = ctx.AdvanceFloat();
            if (ColorOpSources[0] == BOS_Manual) ctx.AdvanceColor(false, ColorOpManualColor1);
            if (ColorOpSources[1] == BOS_Manual) ctx.AdvanceColor(false, ColorOpManualColor2);
        }
        else if (token_name == "alpha_op_ex")
        {
            AlphaOpEx = ctx.AdvanceEnum(BlendOpExEnumerators);
            AlphaOpSources[0] = ctx.AdvanceEnum(BlendOpSourceEnumerators);
            AlphaOpSources[1] = ctx.AdvanceEnum(BlendOpSourceEnumerators);
            if (AlphaOpEx == BOX_BlendManual) AlphaOpManualFactor = ctx.AdvanceFloat();
            if (AlphaOpSources[0] == BOS_Manual) AlphaOpManualAlpha1 = ctx.AdvanceFloat();
            if (AlphaOpSources[1] == BOS_Manual) AlphaOpManualAlpha2 = ctx.AdvanceFloat();
        }
        else if (token_name == "scroll")
        {
            Transformation trans;
            trans.TransformType = Transformation::T_SCROLL;
            trans.Scroll.X = ctx.AdvanceFloat();
            trans.Scroll.Y = ctx.AdvanceFloat();
            Transformations.push_back(trans);
        }
        else if (token_name == "scroll_anim")
        {
            Transformation trans;
            trans.TransformType = Transformation::T_SCROLL_ANIM;
            trans.ScrollAnim.XSpeed = ctx.AdvanceFloat();
            trans.ScrollAnim.YSpeed = ctx.AdvanceFloat();
            Transformations.push_back(trans);
        }
        else if (token_name == "rotate")
        {
            Transformation trans;
            trans.TransformType = Transformation::T_ROTATE;
            trans.Rotate.Angle = ctx.AdvanceFloat();
            Transformations.push_back(trans);
        }
        else if (token_name == "rotate_anim")
        {
            Transformation trans;
            trans.TransformType = Transformation::T_ROTATE_ANIM;
            trans.RotateAnim.RevsPerSec = ctx.AdvanceFloat();
            Transformations.push_back(trans);
        }
        else if (token_name == "scale")
        {
            Transformation trans;
            trans.TransformType = Transformation::T_SCALE;
            trans.Scale.X = ctx.AdvanceFloat();
            trans.Scale.Y = ctx.AdvanceFloat();
            Transformations.push_back(trans);
        }
        else if (token_name == "transform")
        {
            Transformation trans;
            trans.TransformType = Transformation::T_TRANSFORM;
            for (float & i : trans.Transform.M)
                i = ctx.AdvanceFloat();
            Transformations.push_back(trans);
        }
        else if (token_name == "wave_xform")
        {
            Transformation trans;
            trans.TransformType = Transformation::T_WAVE_XFORM;
            trans.WaveXForm.XForm = ctx.AdvanceEnum(XFormTypeEnumerators);
            trans.WaveXForm.Wave = ctx.AdvanceEnum(WaveTypeEnumerators);
            trans.WaveXForm.Base = ctx.AdvanceFloat();
            trans.WaveXForm.Frequency = ctx.AdvanceFloat();
            trans.WaveXForm.Phase = ctx.AdvanceFloat();
            trans.WaveXForm.Amplitude = ctx.AdvanceFloat();
            Transformations.push_back(trans);
        }
        else
            ctx.ErrorUnexpectedIdentifier(token_name);
    }
 
    if (token != TOKEN_BRACE_CLOSE)
        ctx.Error(StdCopyStrBuf("'") + token_name.getData() + "' unexpected");
}

References StdMeshMaterialParserCtx::AdvanceColor(), StdMeshMaterialParserCtx::AdvanceEnum(), StdMeshMaterialParserCtx::AdvanceEnums(), StdMeshMaterialParserCtx::AdvanceFloat(), StdMeshMaterialParserCtx::AdvanceFloatOptional(), StdMeshMaterialParserCtx::AdvanceIntOptional(), StdMeshMaterialParserCtx::AdvanceNonEOF(), StdMeshMaterialParserCtx::AdvanceRequired(), AlphaOpEx, AlphaOpManualAlpha1, AlphaOpManualAlpha2, AlphaOpManualFactor, AlphaOpSources, BO_Add, BO_AlphaBlend, BO_Modulate, BO_Replace, BOS_Current, BOS_Manual, BOS_Texture, BOX_Add, BOX_BlendManual, BOX_BlendTextureAlpha, BOX_Modulate, BOX_Source1, ColorOpEx, ColorOpManualColor1, ColorOpManualColor2, ColorOpManualFactor, ColorOpSources, Duration, StdMeshMaterialParserCtx::Error(), StdMeshMaterialParserCtx::ErrorUnexpectedIdentifier(), F_Anisotropic, F_None, Filtering, StdStrBuf::Format(), StdStrBuf::getData(), LoadTexture(), StdMeshMaterialTextureUnit::Transformation::T_ROTATE, StdMeshMaterialTextureUnit::Transformation::T_ROTATE_ANIM, StdMeshMaterialTextureUnit::Transformation::T_SCALE, StdMeshMaterialTextureUnit::Transformation::T_SCROLL, StdMeshMaterialTextureUnit::Transformation::T_SCROLL_ANIM, StdMeshMaterialTextureUnit::Transformation::T_TRANSFORM, StdMeshMaterialTextureUnit::Transformation::T_WAVE_XFORM, TexAddressMode, TexBorderColor, TOKEN_BRACE_CLOSE, TOKEN_IDTF, Transformations, and StdMeshMaterialTextureUnit::Transformation::TransformType.

Here is the call graph for this function:

LoadTexture()

void StdMeshMaterialTextureUnit::LoadTexture	(	StdMeshMaterialParserCtx &	ctx,
		const char *	texname
	)

Definition at line 1006 of file StdMeshMaterial.cpp.

{
    std::unique_ptr<C4Surface> surface(ctx.Loader.LoadTexture(texname)); // be exception-safe
    if (!surface.get())
        ctx.Error(StdCopyStrBuf("Could not load texture '") + texname + "'");
 
    if (surface->Wdt != surface->Hgt)
        ctx.Error(StdCopyStrBuf("Texture '") + texname + "' is not quadratic");
 
    Textures.emplace_back(surface.release());
}

References StdMeshMaterialParserCtx::Error(), StdMeshMaterialParserCtx::Loader, and StdMeshMaterialLoader::LoadTexture().

Referenced by Load().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

AlphaOpEx

BlendOpExType StdMeshMaterialTextureUnit::AlphaOpEx {BOX_Modulate}

Definition at line 357 of file StdMeshMaterial.h.

Referenced by Load().

AlphaOpManualAlpha1

float StdMeshMaterialTextureUnit::AlphaOpManualAlpha1

Definition at line 360 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialTextureUnit().

AlphaOpManualAlpha2

float StdMeshMaterialTextureUnit::AlphaOpManualAlpha2

Definition at line 361 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialTextureUnit().

AlphaOpManualFactor

float StdMeshMaterialTextureUnit::AlphaOpManualFactor {0.0f}

Definition at line 359 of file StdMeshMaterial.h.

Referenced by Load().

AlphaOpSources

BlendOpSourceType StdMeshMaterialTextureUnit::AlphaOpSources[2]

Definition at line 358 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialTextureUnit().

ColorOpEx

BlendOpExType StdMeshMaterialTextureUnit::ColorOpEx {BOX_Modulate}

Definition at line 351 of file StdMeshMaterial.h.

Referenced by Load().

ColorOpManualColor1

float StdMeshMaterialTextureUnit::ColorOpManualColor1[3]

Definition at line 354 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialTextureUnit().

ColorOpManualColor2

float StdMeshMaterialTextureUnit::ColorOpManualColor2[3]

Definition at line 355 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialTextureUnit().

ColorOpManualFactor

float StdMeshMaterialTextureUnit::ColorOpManualFactor {0.0f}

Definition at line 353 of file StdMeshMaterial.h.

Referenced by Load().

ColorOpSources

BlendOpSourceType StdMeshMaterialTextureUnit::ColorOpSources[2]

Definition at line 352 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialTextureUnit().

Duration

float StdMeshMaterialTextureUnit::Duration {0.0f}

Definition at line 345 of file StdMeshMaterial.h.

Referenced by StdMeshInstance::ExecuteAnimation(), HasFrameAnimation(), and Load().

Filtering

FilteringType StdMeshMaterialTextureUnit::Filtering[3]

Definition at line 349 of file StdMeshMaterial.h.

Referenced by Load(), CStdGL::PrepareMaterial(), and StdMeshMaterialTextureUnit().

Name

StdCopyStrBuf StdMeshMaterialTextureUnit::Name

Definition at line 344 of file StdMeshMaterial.h.

TexAddressMode

TexAddressModeType StdMeshMaterialTextureUnit::TexAddressMode {AM_Wrap}

Definition at line 347 of file StdMeshMaterial.h.

Referenced by Load(), and CStdGL::PrepareMaterial().

TexBorderColor

float StdMeshMaterialTextureUnit::TexBorderColor[4]

Definition at line 348 of file StdMeshMaterial.h.

Referenced by Load(), CStdGL::PrepareMaterial(), and StdMeshMaterialTextureUnit().

Transformations

std::vector<Transformation> StdMeshMaterialTextureUnit::Transformations

Definition at line 364 of file StdMeshMaterial.h.

Referenced by HasTexCoordAnimation(), and Load().

---

The documentation for this class was generated from the following files:

• StdMeshMaterial.h
• StdMeshMaterial.cpp