#include <StdMesh.h>

Collaboration diagram for StdSubMeshInstance:

Classes
struct	Pass

struct	TexUnit

Public Types
enum	FaceOrdering { FO_Fixed , FO_FarthestToNearest , FO_NearestToFarthest }

Public Member Functions
	StdSubMeshInstance (class StdMeshInstance &instance, const StdSubMesh &submesh, float completion)

void	LoadFacesForCompletion (class StdMeshInstance &instance, const StdSubMesh &submesh, float completion)

void	CompileFunc (StdCompiler *pComp)

const StdMeshFace *	GetFaces () const

size_t	GetNumFaces () const

const StdSubMesh &	GetSubMesh () const

unsigned int	GetTexturePhase (size_t pass, size_t texunit) const

double	GetTexturePosition (size_t pass, size_t texunit) const

const StdMeshMaterial &	GetMaterial () const

FaceOrdering	GetFaceOrdering () const

Protected Member Functions
void	SetMaterial (const StdMeshMaterial &material)

void	SetFaceOrdering (class StdMeshInstance &instance, const StdSubMesh &submesh, FaceOrdering ordering)

void	SetFaceOrderingForClrModulation (class StdMeshInstance &instance, const StdSubMesh &submesh, uint32_t clrmod)

Protected Attributes
const StdSubMesh *	base

std::vector< StdMeshFace >	Faces

const StdMeshMaterial *	Material

std::vector< Pass >	PassData

FaceOrdering	CurrentFaceOrdering

Friends
class	StdMeshInstance

class	StdMeshMaterialUpdate

Detailed Description

Definition at line 242 of file StdMesh.h.

Class Documentation

◆ StdSubMeshInstance::Pass

struct StdSubMeshInstance::Pass

Definition at line 295 of file StdMesh.h.

Class Members
vector< TexUnit >	TexUnits

◆ StdSubMeshInstance::TexUnit

struct StdSubMeshInstance::TexUnit

Definition at line 284 of file StdMesh.h.

Class Members
unsigned int	Phase
float	PhaseDelay
double	Position

Member Enumeration Documentation

◆ FaceOrdering

enum StdSubMeshInstance::FaceOrdering

Enumerator
FO_Fixed
FO_FarthestToNearest
FO_NearestToFarthest

Definition at line 248 of file StdMesh.h.

     {
         FO_Fixed, // don't reorder, keep faces as in mesh
         FO_FarthestToNearest,
         FO_NearestToFarthest
     };

Constructor & Destructor Documentation

◆ StdSubMeshInstance()

StdSubMeshInstance::StdSubMeshInstance	(	class StdMeshInstance &	instance,
		const StdSubMesh &	submesh,
		float	completion
	)

Definition at line 660 of file StdMesh.cpp.

                                                                                                             :
     base(&submesh), Material(nullptr), CurrentFaceOrdering(FO_Fixed)
 {
 #ifndef USE_CONSOLE
     LoadFacesForCompletion(instance, submesh, completion);
 #endif
  
     SetMaterial(submesh.GetMaterial());
 }

References StdSubMesh::GetMaterial(), LoadFacesForCompletion(), and SetMaterial().

Here is the call graph for this function:

Member Function Documentation

◆ CompileFunc()

void StdSubMeshInstance::CompileFunc ( StdCompiler * pComp )

Definition at line 755 of file StdMesh.cpp.

 {
     // TODO: We should also serialize the texture animation positions
     if(pComp->isDeserializer())
     {
         StdCopyStrBuf material_name;
         pComp->Value(mkNamingAdapt(material_name, "Material"));
         if(material_name != Material->Name)
         {
             const StdMeshMaterial* material = ::MeshMaterialManager.GetMaterial(material_name.getData());
             if(!material)
             {
                 StdStrBuf buf;
                 buf.Format(R"(There is no such material with name "%s")", material_name.getData());
                 pComp->excCorrupt(buf.getData());
             }
  
             SetMaterial(*material);
         }
     }
     else
     {
         StdCopyStrBuf material_name = Material->Name;
         pComp->Value(mkNamingAdapt(material_name, "Material"));
     }
 }

References StdCompiler::excCorrupt(), StdStrBuf::Format(), StdStrBuf::getData(), StdMeshMatManager::GetMaterial(), StdCompiler::isDeserializer(), Material, MeshMaterialManager, mkNamingAdapt(), StdMeshMaterial::Name, SetMaterial(), and StdCompiler::Value().

Here is the call graph for this function:

◆ GetFaceOrdering()

FaceOrdering StdSubMeshInstance::GetFaceOrdering ( ) const

inline

Definition at line 272 of file StdMesh.h.

272 { return CurrentFaceOrdering; }

References CurrentFaceOrdering.

◆ GetFaces()

const StdMeshFace* StdSubMeshInstance::GetFaces ( ) const

inline

Definition at line 263 of file StdMesh.h.

263 { return Faces.size() > 0 ? &Faces[0] : nullptr; }

StdSubMeshInstance::Faces

std::vector< StdMeshFace > Faces

Definition: StdMesh.h:280

References Faces.

◆ GetMaterial()

const StdMeshMaterial& StdSubMeshInstance::GetMaterial ( ) const

inline

Definition at line 270 of file StdMesh.h.

270 { return *Material; }

References Material.

Referenced by StdMeshInstance::ExecuteAnimation().

Here is the caller graph for this function:

◆ GetNumFaces()

size_t StdSubMeshInstance::GetNumFaces ( ) const

inline

Definition at line 264 of file StdMesh.h.

264 { return Faces.size(); }

References Faces.

◆ GetSubMesh()

const StdSubMesh& StdSubMeshInstance::GetSubMesh ( ) const

inline

Definition at line 265 of file StdMesh.h.

265 { return *base; }

References base.

Referenced by StdMeshInstance::ReorderFaces().

Here is the caller graph for this function:

◆ GetTexturePhase()

unsigned int StdSubMeshInstance::GetTexturePhase	(	size_t	pass,
		size_t	texunit
	)		const

inline

Definition at line 267 of file StdMesh.h.

267 { return PassData[pass].TexUnits[texunit].Phase; }

StdSubMeshInstance::PassData

std::vector< Pass > PassData

Definition: StdMesh.h:300

References PassData.

◆ GetTexturePosition()

double StdSubMeshInstance::GetTexturePosition	(	size_t	pass,
		size_t	texunit
	)		const

inline

Definition at line 268 of file StdMesh.h.

268 { return PassData[pass].TexUnits[texunit].Position; }

References PassData.

◆ LoadFacesForCompletion()

void StdSubMeshInstance::LoadFacesForCompletion	(	class StdMeshInstance &	instance,
		const StdSubMesh &	submesh,
		float	completion
	)

Definition at line 670 of file StdMesh.cpp.

 {
 #ifndef USE_CONSOLE
     // First: Copy all faces
     Faces.resize(submesh.GetNumFaces());
     for (unsigned int i = 0; i < submesh.GetNumFaces(); ++i)
         Faces[i] = submesh.GetFace(i);
  
     if(completion < 1.0f)
     {
         // Second: Order by Y position. StdMeshInstanceFaceOrderingCmpPred orders by Z position,
         // however we can simply give an appropriate transformation matrix to the face ordering.
         // At this point, all vertices are in the OGRE coordinate frame, and Z in OGRE equals
         // Y in Clonk, so we are fine without additional transformation.
         const StdMeshVertex* vertices;
         if(submesh.GetNumVertices() > 0)
             vertices = &submesh.GetVertices()[0];
         else
             vertices = &instance.GetSharedVertices()[0];
         SortFacesArray(vertices, Faces, FO_FarthestToNearest, StdMeshMatrix::Identity());
  
         // Third: Only use the first few ones
         assert(submesh.GetNumFaces() >= 1);
         Faces.resize(Clamp<unsigned int>(static_cast<unsigned int>(completion * submesh.GetNumFaces() + 0.5), 1, submesh.GetNumFaces()));
     }
 #endif
 }

References Faces, FO_FarthestToNearest, StdSubMesh::GetFace(), StdSubMesh::GetNumFaces(), StdSubMesh::GetNumVertices(), StdMeshInstance::GetSharedVertices(), StdSubMesh::GetVertices(), and StdMeshMatrix::Identity().

Referenced by SetFaceOrdering(), and StdSubMeshInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetFaceOrdering()

void StdSubMeshInstance::SetFaceOrdering	(	class StdMeshInstance &	instance,
		const StdSubMesh &	submesh,
		FaceOrdering	ordering
	)

protected

Definition at line 727 of file StdMesh.cpp.

 {
 #ifndef USE_CONSOLE
     if (CurrentFaceOrdering != ordering)
     {
         CurrentFaceOrdering = ordering;
         if (ordering == FO_Fixed)
         {
             LoadFacesForCompletion(instance, submesh, instance.GetCompletion());
         }
     }
 #endif
 }

References CurrentFaceOrdering, FO_Fixed, StdMeshInstance::GetCompletion(), and LoadFacesForCompletion().

Referenced by SetFaceOrderingForClrModulation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetFaceOrderingForClrModulation()

void StdSubMeshInstance::SetFaceOrderingForClrModulation	(	class StdMeshInstance &	instance,
		const StdSubMesh &	submesh,
		uint32_t	clrmod
	)

protected

Definition at line 741 of file StdMesh.cpp.

 {
 #ifndef USE_CONSOLE
     bool opaque = Material->IsOpaque();
  
     if(!opaque)
         SetFaceOrdering(instance, submesh, FO_FarthestToNearest);
     else if( ((clrmod >> 24) & 0xff) != 0xff)
         SetFaceOrdering(instance, submesh, FO_NearestToFarthest);
     else
         SetFaceOrdering(instance, submesh, FO_Fixed);
 #endif
 }

References FO_FarthestToNearest, FO_Fixed, FO_NearestToFarthest, StdMeshMaterial::IsOpaque(), Material, and SetFaceOrdering().

Here is the call graph for this function:

◆ SetMaterial()

void StdSubMeshInstance::SetMaterial ( const StdMeshMaterial & material )

protected

Definition at line 698 of file StdMesh.cpp.

 {
     Material = &material;
  
 #ifndef USE_CONSOLE
     // Setup initial texture animation data
     assert(Material->BestTechniqueIndex >= 0);
     const StdMeshMaterialTechnique& technique = Material->Techniques[Material->BestTechniqueIndex];
     PassData.resize(technique.Passes.size());
     for (unsigned int i = 0; i < PassData.size(); ++i)
     {
         const StdMeshMaterialPass& pass = technique.Passes[i];
         // Clear from previous material
         PassData[i].TexUnits.clear();
  
         for (unsigned int j = 0; j < pass.TextureUnits.size(); ++j)
         {
             TexUnit unit;
             unit.Phase = 0;
             unit.PhaseDelay = 0.0f;
             unit.Position = 0.0;
             PassData[i].TexUnits.push_back(unit);
         }
     }
  
     // TODO: Reset face ordering
 #endif
 }

References StdMeshMaterial::BestTechniqueIndex, Material, PassData, StdMeshMaterialTechnique::Passes, StdSubMeshInstance::TexUnit::Phase, StdSubMeshInstance::TexUnit::PhaseDelay, StdSubMeshInstance::TexUnit::Position, StdMeshMaterial::Techniques, and StdMeshMaterialPass::TextureUnits.

Referenced by CompileFunc(), StdSubMeshInstance(), and StdMeshMaterialUpdate::Update().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ StdMeshInstance

friend class StdMeshInstance

friend

Definition at line 244 of file StdMesh.h.

◆ StdMeshMaterialUpdate

friend class StdMeshMaterialUpdate

friend

Definition at line 245 of file StdMesh.h.

Member Data Documentation

◆ base

const StdSubMesh* StdSubMeshInstance::base

protected

Definition at line 278 of file StdMesh.h.

Referenced by GetSubMesh().

◆ CurrentFaceOrdering

FaceOrdering StdSubMeshInstance::CurrentFaceOrdering

protected

Definition at line 301 of file StdMesh.h.

Referenced by GetFaceOrdering(), StdMeshInstance::ReorderFaces(), and SetFaceOrdering().

◆ Faces

std::vector<StdMeshFace> StdSubMeshInstance::Faces

protected

Definition at line 280 of file StdMesh.h.

Referenced by GetFaces(), GetNumFaces(), LoadFacesForCompletion(), and StdMeshInstance::ReorderFaces().

◆ Material

const StdMeshMaterial* StdSubMeshInstance::Material

protected

Definition at line 282 of file StdMesh.h.

Referenced by CompileFunc(), GetMaterial(), SetFaceOrderingForClrModulation(), SetMaterial(), and StdMeshMaterialUpdate::Update().

◆ PassData

std::vector<Pass> StdSubMeshInstance::PassData

protected

Definition at line 300 of file StdMesh.h.

Referenced by StdMeshInstance::ExecuteAnimation(), GetTexturePhase(), GetTexturePosition(), and SetMaterial().

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Class Documentation

◆ StdSubMeshInstance::Pass

◆ StdSubMeshInstance::TexUnit

Member Enumeration Documentation

◆ FaceOrdering

Constructor & Destructor Documentation

◆ StdSubMeshInstance()

Member Function Documentation

◆ CompileFunc()

◆ GetFaceOrdering()

◆ GetFaces()

◆ GetMaterial()

◆ GetNumFaces()

◆ GetSubMesh()

◆ GetTexturePhase()

◆ GetTexturePosition()

◆ LoadFacesForCompletion()

◆ SetFaceOrdering()

◆ SetFaceOrderingForClrModulation()

◆ SetMaterial()

Friends And Related Function Documentation

◆ StdMeshInstance

◆ StdMeshMaterialUpdate

Member Data Documentation

◆ base

◆ CurrentFaceOrdering

◆ Faces

◆ Material

◆ PassData