paczek/0ad
1
0
Fork 0
forked from 0ad/0ad
Code Pull Requests Activity

Fix units changing appearance when switching animation.

Browse Source 
Bug introduced in 76acc4e146.
The previous CUnit code had logic to select random aesthetic variants
once initially. The new code removed that, as I completely missed its
purpose, assuming that the random selection, being based on a seed,
would pick the same variants every time. This is incorrect because
entity selections can change the RNG calls, thus the variants, and thus
entity appearance can change when the animation changes (typically, a
horse will change color when walking and running).

The solution is to re-introduce the choice of actor selections on CUnit
creation. This makes sure that units don't change their purely-aesthetic
selections when e.g. animations change.

Reported by: Wowgetoffyourcellphone
Tested By: Stan
Differential Revision: https://code.wildfiregames.com/D4205
This was SVN commit r25844.
This commit is contained in:
wraitii 2021-07-31 17:55:10 +00:00
parent 12aa35eb3b
commit 0ba9cbef74
8 changed files with 41 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
source/graphics/ObjectBase.cpp
View File

@ -781,6 +781,14 @@ CActorDef::CActorDef(CObjectManager& objectManager) : m_ObjectManager(objectMana
{
}
std::set<CStr> CActorDef::PickSelectionsAtRandom(uint32_t seed) const
{
// Use the selections from the highest quality actor - this lets artists maintain compatibility (or not)
// when going to lower quality levels.
std::vector<std::set<CStr>> noSelections;
return GetBase(255)->CalculateRandomRemainingSelections(seed, noSelections);
}
std::vector<u8> CActorDef::QualityLevels() const
{
std::vector<u8> splits;

5
source/graphics/ObjectBase.h
View File

@ -229,6 +229,11 @@ public:
VfsPath GetPathname() const { return m_Pathname; }
/**
* Return a list of selections specifying a particular variant in all groups, based on the seed.
*/
std::set<CStr> PickSelectionsAtRandom(uint32_t seed) const;
// Interface accessible from CObjectManager / CObjectBase
protected:
/**

12
source/graphics/Unit.cpp
View File

@ -31,6 +31,15 @@
CUnit::CUnit(CObjectManager& objectManager, const CActorDef& actor, uint32_t seed)
: m_ID(INVALID_ENTITY), m_ObjectManager(objectManager), m_Actor(actor), m_Seed(seed), m_Animation(nullptr)
{
/**
* When entity selections change, we might end up with a different layout in terms of variants/groups,
* which means the random key calculation might end up with different results for the same seed.
* This is bad, as it means entities randomly change appearence when changing e.g. animation.
* To fix this, we'll initially pick a random and complete specification based on our seed,
* and then pass that as the lowest priority selections. Thus, if the actor files are properly specified,
* we can ensure that the entities will look the same no matter what happens.
*/
SetActorSelections(m_Actor.PickSelectionsAtRandom(m_Seed)); // Calls ReloadObject().
}
CUnit::~CUnit()
@ -39,14 +48,13 @@ CUnit::~CUnit()
delete m_Model;
}
CUnit* CUnit::Create(const CStrW& actorName, uint32_t seed, const std::set<CStr>& selections, CObjectManager& objectManager)
CUnit* CUnit::Create(const CStrW& actorName, uint32_t seed, CObjectManager& objectManager)
{
auto [success, actor] = objectManager.FindActorDef(actorName);
UNUSED2(success);
CUnit* unit = new CUnit(objectManager, actor, seed);
unit->SetActorSelections(selections); // Calls ReloadObject().
if (!unit->m_Model)
{
delete unit;

16
source/graphics/Unit.h
View File

@ -42,11 +42,10 @@ private:
CUnit(CObjectManager& objectManager, const CActorDef& actor, uint32_t seed);
public:
// Attempt to create a unit with the given actor, with a set of
// suggested selections (with the rest being randomised using the
// given random seed).
// Attempt to create a unit with the given actor.
// If specific selections are wanted, call SetEntitySelection or SetActorSelections after creation.
// Returns NULL on failure.
static CUnit* Create(const CStrW& actorName, uint32_t seed, const std::set<CStr>& selections, CObjectManager& objectManager);
static CUnit* Create(const CStrW& actorName, uint32_t seed, CObjectManager& objectManager);
// destructor
~CUnit();
@ -77,6 +76,9 @@ public:
const std::set<CStr>& GetActorSelections() const { return m_ActorSelections; }
/**
* Overwrite the seed-selected actor selections. Likely only useful for Atlas or debugging.
*/
void SetActorSelections(const std::set<CStr>& selections);
private:
@ -96,9 +98,11 @@ private:
// seed used when creating unit
uint32_t m_Seed;
// actor-level selections for this unit
// Actor-level selections for this unit. This is normally set at init time,
// so that we always re-use the same aesthetic variants.
// These have lower priority than entity-level selections.
std::set<CStr> m_ActorSelections;
// entity-level selections for this unit
// Entity-level selections for this unit (used for e.g. animation variants).
std::map<CStr, CStr> m_EntitySelections;
// object manager which looks after this unit's objectentry

6
source/graphics/UnitManager.cpp
View File

@ -1,4 +1,4 @@
/* Copyright (C) 2012 Wildfire Games.
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@ -87,12 +87,12 @@ void CUnitManager::DeleteAll()
///////////////////////////////////////////////////////////////////////////////
// CreateUnit: create a new unit and add it to the world
CUnit* CUnitManager::CreateUnit(const CStrW& actorName, uint32_t seed, const std::set<CStr8>& selections)
CUnit* CUnitManager::CreateUnit(const CStrW& actorName, uint32_t seed)
{
if (! m_ObjectManager)
return NULL;
CUnit* unit = CUnit::Create(actorName, seed, selections, *m_ObjectManager);
CUnit* unit = CUnit::Create(actorName, seed, *m_ObjectManager);
if (unit)
AddUnit(unit);
return unit;

4
source/graphics/UnitManager.h
View File

@ -1,4 +1,4 @@
/* Copyright (C) 2012 Wildfire Games.
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
@ -50,7 +50,7 @@ public:
void DeleteAll();
// creates a new unit and adds it to the world
CUnit* CreateUnit(const CStrW& actorName, uint32_t seed, const std::set<CStr8>& selections);
CUnit* CreateUnit(const CStrW& actorName, uint32_t seed);
// return the units
const std::vector<CUnit*>& GetUnits() const { return m_Units; }

6
source/simulation2/components/CCmpProjectileManager.cpp
View File

@ -202,8 +202,7 @@ uint32_t CCmpProjectileManager::LaunchProjectile(CFixedVector3D launchPoint, CFi
projectile.origin = launchPoint;
std::set<CStr> selections;
projectile.unit = GetSimContext().GetUnitManager().CreateUnit(actorName, m_ActorSeed++, selections);
projectile.unit = GetSimContext().GetUnitManager().CreateUnit(actorName, m_ActorSeed++);
if (!projectile.unit) // The error will have already been logged
return currentId;
@ -302,8 +301,7 @@ void CCmpProjectileManager::Interpolate(float frameTime)
quat.ToMatrix(transform);
transform.Translate(m_Projectiles[i].pos);
std::set<CStr> selections;
CUnit* unit = GetSimContext().GetUnitManager().CreateUnit(m_Projectiles[i].impactActorName, m_ActorSeed++, selections);
CUnit* unit = GetSimContext().GetUnitManager().CreateUnit(m_Projectiles[i].impactActorName, m_ActorSeed++);
unit->GetModel().SetTransform(transform);
ProjectileImpactAnimation projectileImpactAnimation;

3
source/simulation2/components/CCmpVisualActor.cpp
View File

@ -598,11 +598,10 @@ void CCmpVisualActor::InitModel()
if (!GetSimContext().HasUnitManager())
return;
std::set<CStr> selections;
std::wstring actorName = m_ActorName;
if (actorName.find(L".xml") == std::wstring::npos)
actorName += L".xml";
m_Unit = GetSimContext().GetUnitManager().CreateUnit(actorName, GetActorSeed(), selections);
m_Unit = GetSimContext().GetUnitManager().CreateUnit(actorName, GetActorSeed());
if (!m_Unit)
return;