Skip to content

Update VoxelIndexKey #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 31, 2025
Merged

Update VoxelIndexKey #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d59a1bb
Core
CrimRecya Jul 12, 2025
e909a7c
Fix mistake
CrimRecya Jul 12, 2025
b9211c0
Update
CrimRecya Jul 13, 2025
6bb6c78
Merge remote-tracking branch 'upstream/phobos-dev' into YRpp-CR250712
CrimRecya Jul 15, 2025
df844f5
Supplement the destructors of LinkClass and GadgetClass
CrimRecya Jul 31, 2025
b33c7c0
Merge remote-tracking branch 'upstream/phobos-dev' into YRpp-CR250712
CrimRecya Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
242 changes: 210 additions & 32 deletions Drawing.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,48 +300,224 @@ struct VoxelCacheStruct
void* Buffer;
};

/*
----------------------------------------------------------------------------------------------------
> Jul 13, 2025 - CrimRecya
> How does WW generate a VoxelIndexKey:
----------------------------------------------------------------------------------------------------

----------------------------------------------------------------------------------------------------
> Unit:
>
> 0x73B59D : key = Game::bVPLRead - 1;
> ···· ···· ···· ···· ···· ···· ···· ····
>
> 0x73B5CB : loco->Draw_Matrix(&mtx, &key);
> Drive/Ship/Teleport/Hover(!Powered)/Jumpjet(!State)/Tunnel(!State) ···· ···· ···· ···· ···· ·rrr rrrb bbbb
> Hover(Powered)/Jumpjet(State)/DropPod/Mech/Walk ···· ···· ···· ···· ···· ·000 000b bbbb
> Tunnel(State) ···· ···· ···· ···· ···b bbbb 00dd dddd
> Fly ···· ···· ···· ···· ···· ···· bbbb bplr
> Rocket ···· ···· ···· ···· ···· ···· ·fib bbbb
>
> 0x73B607 : key = (((this->WalkedFramesSoFar % Type->MainVoxel.HVA->FrameCount) & 0x1F) | (key << 5));
> Drive/Ship/Teleport/Hover(!Powered)/Jumpjet(!State)/Tunnel(!State) ···· ···· ···· ···· rrrr rrbb bbbf ffff
> Hover(Powered)/Jumpjet(State)/DropPod/Mech/Walk ···· ···· ···· ···· 0000 00bb bbbf ffff
> Tunnel(State) ···· ···· ···· ··bb bbb0 0ddd dddf ffff
> Fly ···· ···· ···· ···· ···b bbbb plrf ffff
> Rocket ···· ···· ···· ···· ···· fibb bbbf ffff
>
> 0x73B6AA : key = key | (1 << 16); (if (this->Type->NoSpawnAlt && !this->SpawnManager->CountDockedSpawns()))
> Drive/Ship/Teleport/Hover(!Powered)/Jumpjet(!State)/Tunnel(!State) ···· ···· ···· ···a rrrr rrbb bbbf ffff
> Hover(Powered)/Jumpjet(State)/DropPod/Mech/Walk ···· ···· ···· ···a 0000 00bb bbbf ffff
> Tunnel(State) ···· ···· ···· ··b? bbb0 0ddd dddf ffff
> Fly ···· ···· ···· ···a ···b bbbb plrf ffff
> Rocket ···· ···· ···· ···a ···· fibb bbbf ffff
>
> Obtain main result
>
> Draw main
>
> 0x73B778 : key = (this->SecondaryFacing.Current().GetFacing<32>() | (key & ~0x1F));
> Drive/Ship/Teleport/Hover(!Powered)/Jumpjet(!State)/Tunnel(!State) ···· ···· ···· ···· rrrr rrbb bbbt tttt
> Hover(Powered)/Jumpjet(State)/DropPod/Mech/Walk ···· ···· ···· ···· 0000 00bb bbbt tttt
> Tunnel(State) ···· ···· ···· ··bb bbb0 0ddd dddt tttt
> Fly ···· ···· ···· ···· ···b bbbb plrt tttt
> Rocket ···· ···· ···· ···· ···· fibb bbbt tttt
>
> 0x73B78A : key = key & ~0x3E0; (if (!this->Type->TurretOffset))
> Drive/Ship/Teleport/Hover(!Powered)/Jumpjet(!State)/Tunnel(!State) ···· ···· ···· ···· rrrr rr00 000t tttt
> Hover(Powered)/Jumpjet(State)/DropPod/Mech/Walk ···· ···· ···· ···· 0000 0000 000t tttt
> Tunnel(State) ···· ···· ···· ··bb bbb0 0d?? ???t tttt
> Fly ···· ···· ···· ···· ···b bb?? ???t tttt
> Rocket ···· ···· ···· ···· ···· fi00 000t tttt
>
> 0x73B79F : key = key | ((this->TurretAnimFrame % Type->TurretVoxel.HVA->FrameCount) << 16);
> Drive/Ship/Teleport/Hover(!Powered)/Jumpjet(!State)/Tunnel(!State) ···· ···· iiii iiii rrrr rrbb bbbt tttt
> Hover(Powered)/Jumpjet(State)/DropPod/Mech/Walk ···· ···· iiii iiii 0000 00bb bbbt tttt
> Tunnel(State) ···· ···· iiii ii?? bbb0 0ddd dddt tttt
> Fly ···· ···· iiii iiii ···b bbbb plrt tttt
> Rocket ···· ···· iiii iiii ···· fibb bbbt tttt
>
> Draw barrel if no turret
>
> 0x73B917 : key = key | (this->CurrentTurretNumber << 24);
> Drive/Ship/Teleport/Hover(!Powered)/Jumpjet(!State)/Tunnel(!State) cccc cccc iiii iiii rrrr rrbb bbbt tttt
> Hover(Powered)/Jumpjet(State)/DropPod/Mech/Walk cccc cccc iiii iiii 0000 00bb bbbt tttt
> Tunnel(State) cccc cccc iiii ii?? bbb0 0ddd dddt tttt
> Fly cccc cccc iiii iiii ···b bbbb plrt tttt
> Rocket cccc cccc iiii iiii ···· fibb bbbt tttt
>
> Obtain minor result
>
> Draw minor
>
> ... Then shadow ...
----------------------------------------------------------------------------------------------------

----------------------------------------------------------------------------------------------------
> Aircraft:
>
> 0x41470F : key = 0;
> ···· ···· ···· ···· ···· ···· ···· ····
>
> ... Draw Shadow ...
>
> 0x414943 : key = ((this->WalkedFramesSoFar % Type->MainVoxel.HVA->FrameCount) & 0x1F);
> ···· ···· ···· ···· ···· ···· ···f ffff
>
> 0x414969 : loco->Draw_Matrix(&mtx, &key);
> Drive/Ship/Teleport/Hover(!Powered)/Jumpjet(!State)/Tunnel(!State) ···· ···· ···· ···· ffff frrr rrrb bbbb
> Hover(Powered)/Jumpjet(State)/DropPod/Mech/Walk ···· ···· ···· ···· ffff f000 000b bbbb
> Tunnel(State) ···· ···· ···· ··ff fffb bbbb 00dd dddd
> Fly ···· ···· ···· ···· ···· ···· bbb? ????
> Rocket ···· ···· ···· ···· ···· ···· ·fi? ????
>
> Obtain main result
>
> Draw main
----------------------------------------------------------------------------------------------------

----------------------------------------------------------------------------------------------------
> Draw_Matrix:
>
> Drive/Ship/Teleport/Hover/Jumpjet/Tunnel(!State)/DropPod/Mech/Walk: <<= 6 , += , <<= 5 , |=
>
> Tunnel(State) <<= 5 , |= , <<= 8 , |=
>
> Fly/Rocket: |= , |= (No shift)
>
> Return
----------------------------------------------------------------------------------------------------
*/

struct MainVoxelIndexKey
{
public:
/*
pUnit->WalkedFramesSoFar % pType->MainVoxel.HVA->FrameCount
*/
unsigned FrameIndex : 5;
unsigned RampType : 5;
private:
unsigned bitfield_10 : 6;
public:
unsigned UseAuxVoxel : 1; // !(!pUnit->Type->NoSpawnAlt || pUnit->SpawnManager->Draw_State())
private:
unsigned bitfield_17 : 15;

/*
pUnit->PrimaryFacing.Current().GetFacing<32>()
*/
unsigned BodyFacing : 5;

/*
Drive : Loco->Ramp
Ship : Loco->Ramp
Hover (!loco->Is_Powered()): pUnit->GetCell()->SlopeIndex
Jumpjet (!loco->State): pUnit->GetCell()->SlopeIndex
Tunnel (!loco->State): pUnit->GetCell()->SlopeIndex
Teleport (Fixed) : pUnit->GetCell()->SlopeIndex
DropPod / Mech / Walk : Not set
*/
unsigned RampType : 6;

/*
pUnit->Type->NoSpawnAlt && !pUnit->SpawnManager->CountDockedSpawns()
*/
unsigned AuxVoxel : 1;

/*
No use
*/
unsigned Reserved : 15;
};

struct TurretWeaponVoxelIndexKey
struct MinorVoxelIndexKey
{
public:
unsigned Facing : 5;
unsigned HasTurretOffset : 5;
private:
unsigned bitfield_10 : 6;
public:
unsigned FrameIndex : 8;
/*
pUnit->SecondaryFacing.Current().GetFacing<32>()
*/
unsigned TurretFacing : 5;

/*
Inherit from MainVoxelIndexKey

Reset to 0 if TurretOffset=0
*/
unsigned BodyFacing : 5;

/*
Inherit from MainVoxelIndexKey
*/
unsigned RampType : 6;

/*
pUnit->TurretAnimFrame % pType->TurretVoxel.HVA->FrameCount

Not set if have MainVoxelIndexKey.FrameIndex
*/
unsigned TurretFrameIndex : 8;

/*
pUnit->CurrentTurretNumber

Not set if no turret but have barrel
*/
unsigned TurretWeaponIndex : 8;
};

struct ShadowVoxelIndexKey
struct AircraftVoxelIndexKey
{
public:
unsigned Data : 32;
unsigned BodyFacing : 5;
unsigned RampType : 6;
unsigned FrameIndex : 5;
unsigned Reserved : 16;
};

struct TurretBarrelVoxelIndexKey
struct FlyVoxelIndexKey
{
unsigned FrameIndex : 5;
unsigned RollRight : 1;
unsigned RollLeft : 1;
unsigned PitchState : 1;
unsigned BodyFacing : 5;
unsigned Reserved : 19;
};

struct RocketVoxelIndexKey
{
unsigned FrameIndex : 5;
unsigned BodyFacing : 5;
unsigned InitialPitch : 1;
unsigned FinalPitch : 1;
unsigned Reserved : 20;
};

struct TunnelVoxelIndexKey
{
unsigned FrameIndex : 5;
unsigned DigState : 6;
unsigned Empty : 2;
unsigned BodyFacing : 5;
unsigned Reserved : 14;
};

struct ShadowVoxelIndexKey
{
public:
unsigned Facing : 5;
unsigned HasTurretOffset : 5;
private:
unsigned bitfield_10 : 6;
public:
unsigned FrameIndex : 8;
private:
unsigned bitfield_24 : 8;
unsigned Data : 32;
};

struct ReservedVoxelIndexKey
Expand Down Expand Up @@ -376,12 +552,14 @@ union VoxelIndexKey
Value = -1;
}

MainVoxelIndexKey MainVoxel;
TurretWeaponVoxelIndexKey TurretWeapon;
MainVoxelIndexKey MainVoxel; // (Unit) For body to use
MinorVoxelIndexKey MinorVoxel; // (Unit) For turret/barrel to use
AircraftVoxelIndexKey AircraftVoxel;
FlyVoxelIndexKey FlyVoxel; // (Unit)
RocketVoxelIndexKey RocketVoxel; // (Unit)
TunnelVoxelIndexKey UndergroundVoxel; // (Unit) loco->State != 0
ShadowVoxelIndexKey Shadow;
TurretBarrelVoxelIndexKey TurretBarrel;
ReservedVoxelIndexKey Reserved;
private:
int Value;
};

Expand Down
2 changes: 1 addition & 1 deletion GadgetClass.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class NOVTABLE GadgetClass : public LinkClass
public:

//Destructor
virtual ~GadgetClass() RX;
virtual ~GadgetClass() override { JMP_THIS(0x4E1390); }

//LinkClass
virtual GadgetClass* GetNext() override { JMP_THIS(0x4E14A0); }
Expand Down
2 changes: 1 addition & 1 deletion LinkClass.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ class LinkClass
{
public:
//Destructor
virtual ~LinkClass() RX;
virtual ~LinkClass() { JMP_THIS(0x5565A0); }

//LinkClass
virtual LinkClass* GetNext() { JMP_THIS(0x556620); }
Expand Down
6 changes: 3 additions & 3 deletions ObjectTypeClass.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,8 @@ class NOVTABLE ObjectTypeClass : public AbstractTypeClass
PROTECTED_PROPERTY(BYTE, align_23E[2]);
int LineTrailColorDecrement;

IndexClass<MainVoxelIndexKey, VoxelCacheStruct*> VoxelMainCache;
IndexClass<TurretWeaponVoxelIndexKey, VoxelCacheStruct*> VoxelTurretWeaponCache;
IndexClass<VoxelIndexKey, VoxelCacheStruct*> VoxelMainCache;
IndexClass<VoxelIndexKey, VoxelCacheStruct*> VoxelTurretWeaponCache;
IndexClass<ShadowVoxelIndexKey, VoxelCacheStruct*> VoxelShadowCache;
IndexClass<TurretBarrelVoxelIndexKey, VoxelCacheStruct*> VoxelTurretBarrelCache;
IndexClass<VoxelIndexKey, VoxelCacheStruct*> VoxelTurretBarrelCache;
};