Skip to content

Commit

Permalink
Refactor|Material|MaterialManifest: Various convention and style clea…
Browse files Browse the repository at this point in the history 
…nup refactorings
  • Loading branch information
@danij-deng
danij-deng committed Mar 1, 2013
1 parent b3cb674 commit 64e6185
Show file tree
Hide file tree
Showing 5 changed files with 94 additions and 93 deletions.
6 changes: 3 additions & 3 deletions doomsday/client/include/resource/material.h
View file
Expand Up @@ -570,14 +570,14 @@ class Material : public de::MapElement
*
* @return Human-friendly description/overview of the material.
*/
de::String composeDescription() const;
de::String description() const;

/**
* Returns a textual synopsis of the material's configuration.
* Returns a textual synopsis of the full material configuration.
*
* @return Human-friendly synopsis of the material's configuration.
*/
de::String composeSynopsis() const;
de::String synopsis() const;

/**
* Returns @c true if the material is considered @em valid. A material is
Expand Down
7 changes: 7 additions & 0 deletions doomsday/client/include/resource/materialmanifest.h
View file
Expand Up @@ -88,6 +88,13 @@ class MaterialManifest : public PathTree::Node
return Uri(schemeName(), path(sep));
}

/**
* Returns a textual description of the manifest.
*
* @return Human-friendly description the manifest.
*/
String description(Uri::ComposeAsTextFlags uriCompositionFlags = Uri::DefaultComposeAsTextFlags) const;

/**
* Returns a textual description of the source of the manifest.
*
Expand Down
6 changes: 3 additions & 3 deletions doomsday/client/src/resource/material.cpp
View file
Expand Up @@ -640,7 +640,7 @@ void Material::markValid(bool yes)
d->valid = yes;
}

String Material::composeDescription() const
String Material::description() const
{
String str = String("Material \"%1\"").arg(manifest().composeUri().asText());
#ifdef DENG_DEBUG
Expand All @@ -656,7 +656,7 @@ String Material::composeDescription() const
return str;
}

String Material::composeSynopsis() const
String Material::synopsis() const
{
String str = String("Drawable:%1 EnvClass:\"%2\"")
.arg(isDrawable()? "yes" : "no")
Expand Down Expand Up @@ -686,7 +686,7 @@ String Material::composeSynopsis() const
: QString("(prev)");

str += String("\n #%1: Texture:\"%2\" Tics:%3 (~%4)"
"\n Offset:%5 Glow:%6 (~%7)")
"\n Offset:%5 Glow:%6 (~%7)")
.arg(k)
.arg(path)
.arg(sDef.tics)
Expand Down
12 changes: 12 additions & 0 deletions doomsday/client/src/resource/materialmanifest.cpp
View file
Expand Up @@ -91,6 +91,18 @@ MaterialScheme &MaterialManifest::scheme() const
throw Error("MaterialManifest::scheme", String("Failed to determine scheme for manifest [%1]").arg(de::dintptr(this)));
}

String MaterialManifest::description(de::Uri::ComposeAsTextFlags uriCompositionFlags) const
{
String info = String("%1 %2")
.arg(composeUri().compose(uriCompositionFlags | de::Uri::DecodePath),
( uriCompositionFlags.testFlag(de::Uri::OmitScheme)? -14 : -22 ) )
.arg(sourceDescription(), -7);
#ifdef __CLIENT__
info += String("x%1").arg(!hasMaterial()? 0 : material().variantCount());
#endif
return info;
}

String MaterialManifest::sourceDescription() const
{
if(!isCustom()) return "game";
Expand Down
156 changes: 69 additions & 87 deletions doomsday/client/src/resource/materials.cpp
View file
Expand Up @@ -489,81 +489,7 @@ MaterialVariantSpec const &Materials::variantSpecForContext(
mipmapped, gammaCorrection, noStretch, toAlpha);
}

static void printVariantInfo(MaterialVariant &variant, int variantIdx)
{
Con_Message("Variant #%i: Spec:%p", variantIdx, de::dintptr(&variant.spec()));

// Print layer state info:
int const layerCount = variant.generalCase().layerCount();
for(int i = 0; i < layerCount; ++i)
{
MaterialVariant::LayerState const &l = variant.layer(i);
Con_Message(" Layer #%i: Stage:%i Tics:%i", i, l.stage, int(l.tics));
}

// Print detail layer state info:
if(variant.generalCase().isDetailed())
{
MaterialVariant::LayerState const &l = variant.detailLayer();
Con_Message(" DetailLayer #0: Stage:%i Tics:%i", l.stage, int(l.tics));
}

// Print shine layer state info:
if(variant.generalCase().isShiny())
{
MaterialVariant::LayerState const &l = variant.shineLayer();
Con_Message(" ShineLayer #0: Stage:%i Tics:%i", l.stage, int(l.tics));
}

// Print decoration state info:
int const decorationCount = variant.generalCase().decorationCount();
for(int i = 0; i < decorationCount; ++i)
{
MaterialVariant::DecorationState const &l = variant.decoration(i);
Con_Message(" Decoration #%i: Stage:%i Tics:%i", i, l.stage, int(l.tics));
}
}

#endif // __CLIENT__

static void printMaterialInfo(Material &material)
{
// Print description:
Con_Message(material.composeDescription().toUtf8().constData());

// Print synopsis:
Con_Message(material.composeSynopsis().toUtf8().constData());

#ifdef __CLIENT__
if(!material.variantCount()) return;

// Print variant specs and current animation states:
Con_PrintRuler();

int variantIdx = 0;
foreach(MaterialVariant *variant, material.variants())
{
printVariantInfo(*variant, variantIdx);
++variantIdx;
}

#endif // __CLIENT__
}

static void printManifestInfo(MaterialManifest &manifest,
de::Uri::ComposeAsTextFlags uriCompositionFlags = de::Uri::DefaultComposeAsTextFlags)
{
String info = String("%1 %2")
.arg(manifest.composeUri().compose(uriCompositionFlags | de::Uri::DecodePath),
( uriCompositionFlags.testFlag(de::Uri::OmitScheme)? -14 : -22 ) )
.arg(manifest.sourceDescription(), -7);
#ifdef __CLIENT__
info += String("x%1").arg(!manifest.hasMaterial()? 0 : manifest.material().variantCount());
#endif

info += "\n";
Con_FPrintf(!manifest.hasMaterial()? CPF_LIGHT : CPF_WHITE, info.toUtf8().constData());
}

static bool pathBeginsWithComparator(MaterialManifest const &manifest, void *parameters)
{
Expand Down Expand Up @@ -645,13 +571,13 @@ static bool compareManifestPathsAssending(MaterialManifest const *a, MaterialMan
* @param like Material path search term.
* @param composeUriFlags Flags governing how URIs should be composed.
*/
static int printMaterials2(MaterialScheme *scheme, Path const &like,
Uri::ComposeAsTextFlags composeUriflags)
static int printIndex2(MaterialScheme *scheme, Path const &like,
Uri::ComposeAsTextFlags composeUriFlags)
{
QList<MaterialManifest *> found = collectManifests(scheme, like);
if(found.isEmpty()) return 0;

bool const printSchemeName = !(composeUriflags & Uri::OmitScheme);
bool const printSchemeName = !(composeUriFlags & Uri::OmitScheme);

// Print a heading.
String heading = "Known materials";
Expand All @@ -678,14 +604,17 @@ static int printMaterials2(MaterialScheme *scheme, Path const &like,
int idx = 0;
foreach(MaterialManifest *manifest, found)
{
Con_Printf(" %*i: ", numFoundDigits, idx++);
printManifestInfo(*manifest, composeUriflags);
String info = String("%1: ").arg(idx, -numFoundDigits, 10)
+ manifest->description(composeUriFlags);

Con_FPrintf(!manifest->hasMaterial()? CPF_LIGHT : CPF_WHITE, "%s\n", info.toUtf8().constData());
idx++;
}

return found.count();
}

static void printMaterials(de::Uri const &search,
static void printIndex(de::Uri const &search,
de::Uri::ComposeAsTextFlags flags = de::Uri::DefaultComposeAsTextFlags)
{
Materials &materials = App_Materials();
Expand All @@ -695,29 +624,29 @@ static void printMaterials(de::Uri const &search,
// Collate and print results from all schemes?
if(search.scheme().isEmpty() && !search.path().isEmpty())
{
printTotal = printMaterials2(0/*any scheme*/, search.path(), flags & ~de::Uri::OmitScheme);
printTotal = printIndex2(0/*any scheme*/, search.path(), flags & ~de::Uri::OmitScheme);
Con_PrintRuler();
}
// Print results within only the one scheme?
else if(materials.knownScheme(search.scheme()))
{
printTotal = printMaterials2(&materials.scheme(search.scheme()), search.path(), flags | de::Uri::OmitScheme);
printTotal = printIndex2(&materials.scheme(search.scheme()), search.path(), flags | de::Uri::OmitScheme);
Con_PrintRuler();
}
else
{
// Collect and sort results in each scheme separately.
foreach(MaterialScheme *scheme, materials.allSchemes())
{
int numPrinted = printMaterials2(scheme, search.path(), flags | de::Uri::OmitScheme);
int numPrinted = printIndex2(scheme, search.path(), flags | de::Uri::OmitScheme);
if(numPrinted)
{
Con_PrintRuler();
printTotal += numPrinted;
}
}
}
Con_Printf("Found %i %s.\n", printTotal, printTotal == 1? "Material" : "Materials");
Con_Message("Found %i %s.", printTotal, printTotal == 1? "Material" : "Materials");
}

} // namespace de
Expand All @@ -739,7 +668,7 @@ D_CMD(ListMaterials)
return false;
}

de::printMaterials(search);
de::printIndex(search);
return true;
}

Expand All @@ -760,11 +689,64 @@ D_CMD(InspectMaterial)
de::MaterialManifest &manifest = materials.find(search);
if(manifest.hasMaterial())
{
de::printMaterialInfo(manifest.material());
Material &material = manifest.material();

// Print material description:
Con_Message(material.description().toUtf8().constData());

// Print material synopsis:
Con_Message(material.synopsis().toUtf8().constData());

#ifdef __CLIENT__
if(material.variantCount())
{
// Print variant specs and current animation states:
Con_PrintRuler();

int variantIdx = 0;
foreach(MaterialVariant *variant, material.variants())
{
Con_Message("Variant #%i: Spec:%p", variantIdx, de::dintptr(&variant->spec()));

// Print layer state info:
int const layerCount = material.layerCount();
for(int i = 0; i < layerCount; ++i)
{
MaterialVariant::LayerState const &l = variant->layer(i);
Con_Message(" Layer #%i: Stage:%i Tics:%i", i, l.stage, int(l.tics));
}

// Print detail layer state info:
if(material.isDetailed())
{
MaterialVariant::LayerState const &l = variant->detailLayer();
Con_Message(" DetailLayer #0: Stage:%i Tics:%i", l.stage, int(l.tics));
}

// Print shine layer state info:
if(material.isShiny())
{
MaterialVariant::LayerState const &l = variant->shineLayer();
Con_Message(" ShineLayer #0: Stage:%i Tics:%i", l.stage, int(l.tics));
}

// Print decoration state info:
int const decorationCount = material.decorationCount();
for(int i = 0; i < decorationCount; ++i)
{
MaterialVariant::DecorationState const &l = variant->decoration(i);
Con_Message(" Decoration #%i: Stage:%i Tics:%i", i, l.stage, int(l.tics));
}

++variantIdx;
}
}
#endif // __CLIENT__
}
else
{
de::printManifestInfo(manifest);
de::String description = manifest.description();
Con_FPrintf(CPF_LIGHT, "%s\n", description.toUtf8().constData());
}
return true;
}
Expand Down

0 comments on commit 64e6185

Please sign in to comment.