Skip to content

Commit

Permalink
Refactor: Use helper struct to avoid passing so many parameters on ob…
Browse files Browse the repository at this point in the history 
…ject create
  • Loading branch information
@leezer3
leezer3 committed Apr 10, 2024
1 parent 46d1393 commit 8f543c6
Show file tree
Hide file tree
Showing 33 changed files with 218 additions and 192 deletions.
30 changes: 15 additions & 15 deletions source/LibRender2/BaseRenderer.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -523,14 +523,14 @@ public void Reset()
Initialize();
}

public int CreateStaticObject(StaticObject Prototype, Vector3 Position, Transformation WorldTransformation, Transformation LocalTransformation, ObjectDisposalMode AccurateObjectDisposal, double AccurateObjectDisposalZOffset, double StartingDistance, double EndingDistance, double BlockLength, double TrackPosition, double Brightness)
public int CreateStaticObject(StaticObject Prototype, Vector3 Position, Transformation WorldTransformation, Transformation LocalTransformation, ObjectDisposalMode AccurateObjectDisposal, double AccurateObjectDisposalZOffset, WorldProperties Properties, double BlockLength)
{
Matrix4D Translate = Matrix4D.CreateTranslation(Position.X, Position.Y, -Position.Z);
Matrix4D Rotate = (Matrix4D)new Transformation(LocalTransformation, WorldTransformation);
return CreateStaticObject(Position, Prototype, LocalTransformation, Rotate, Translate, AccurateObjectDisposal, AccurateObjectDisposalZOffset, StartingDistance, EndingDistance, BlockLength, TrackPosition, Brightness);
return CreateStaticObject(Position, Prototype, LocalTransformation, Rotate, Translate, AccurateObjectDisposal, AccurateObjectDisposalZOffset, Properties, BlockLength);
}

public int CreateStaticObject(Vector3 Position, StaticObject Prototype, Transformation LocalTransformation, Matrix4D Rotate, Matrix4D Translate, ObjectDisposalMode AccurateObjectDisposal, double AccurateObjectDisposalZOffset, double StartingDistance, double EndingDistance, double BlockLength, double TrackPosition, double Brightness)
public int CreateStaticObject(Vector3 Position, StaticObject Prototype, Transformation LocalTransformation, Matrix4D Rotate, Matrix4D Translate, ObjectDisposalMode AccurateObjectDisposal, double AccurateObjectDisposalZOffset, WorldProperties Properties, double BlockLength)
{
if (Prototype == null)
{
Expand Down Expand Up @@ -578,21 +578,21 @@ public int CreateStaticObject(Vector3 Position, StaticObject Prototype, Transfor
switch (AccurateObjectDisposal)
{
case ObjectDisposalMode.Accurate:
startingDistance += (float)TrackPosition;
endingDistance += (float)TrackPosition;
double z = BlockLength * Math.Floor(TrackPosition / BlockLength);
StartingDistance = Math.Min(z - BlockLength, startingDistance);
EndingDistance = Math.Max(z + 2.0 * BlockLength, endingDistance);
startingDistance = (float)(BlockLength * Math.Floor(StartingDistance / BlockLength));
endingDistance = (float)(BlockLength * Math.Ceiling(EndingDistance / BlockLength));
startingDistance += (float)Properties.TrackPosition;
endingDistance += (float)Properties.TrackPosition;
double z = BlockLength * Math.Floor(Properties.TrackPosition / BlockLength);
Properties.StartingDistance = Math.Min(z - BlockLength, startingDistance);
Properties.EndingDistance = Math.Max(z + 2.0 * BlockLength, endingDistance);
startingDistance = (float)(BlockLength * Math.Floor(Properties.StartingDistance / BlockLength));
endingDistance = (float)(BlockLength * Math.Ceiling(Properties.EndingDistance / BlockLength));
break;
case ObjectDisposalMode.Legacy:
startingDistance = (float)StartingDistance;
endingDistance = (float)EndingDistance;
startingDistance = (float)Properties.StartingDistance;
endingDistance = (float)Properties.EndingDistance;
break;
case ObjectDisposalMode.Mechanik:
startingDistance = (float) StartingDistance;
endingDistance = (float) EndingDistance + 1500;
startingDistance = (float)Properties.StartingDistance;
endingDistance = (float)Properties.EndingDistance + 1500;
if (startingDistance < 0)
{
startingDistance = 0;
Expand All @@ -604,7 +604,7 @@ public int CreateStaticObject(Vector3 Position, StaticObject Prototype, Transfor
Prototype = Prototype,
Translation = Translate,
Rotate = Rotate,
Brightness = Brightness,
Brightness = Properties.Brightness,
StartingDistance = startingDistance,
EndingDistance = endingDistance,
WorldPosition = Position
Expand Down
8 changes: 4 additions & 4 deletions source/ObjectViewer/Hosts.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -303,14 +303,14 @@ public override void ExecuteFunctionScript(OpenBveApi.FunctionScripting.Function
FunctionScripts.ExecuteFunctionScript(functionScript, (TrainBase)train, CarIndex, Position, TrackPosition, SectionIndex, IsPartOfTrain, TimeElapsed, CurrentState);
}

public override int CreateStaticObject(StaticObject Prototype, Vector3 Position, Transformation WorldTransformation, Transformation LocalTransformation, double AccurateObjectDisposalZOffset, double StartingDistance, double EndingDistance, double TrackPosition, double Brightness)
public override int CreateStaticObject(StaticObject Prototype, Vector3 Position, Transformation WorldTransformation, Transformation LocalTransformation, double AccurateObjectDisposalZOffset, WorldProperties Properties)
{
return Program.Renderer.CreateStaticObject(Prototype, Position, WorldTransformation, LocalTransformation, ObjectDisposalMode.Accurate, AccurateObjectDisposalZOffset, StartingDistance, EndingDistance, 25.0, TrackPosition, Brightness);
return Program.Renderer.CreateStaticObject(Prototype, Position, WorldTransformation, LocalTransformation, ObjectDisposalMode.Accurate, AccurateObjectDisposalZOffset, Properties, 25.0);
}

public override int CreateStaticObject(StaticObject Prototype, Vector3 Position, Transformation LocalTransformation, Matrix4D Rotate, Matrix4D Translate, double AccurateObjectDisposalZOffset, double StartingDistance, double EndingDistance, double TrackPosition, double Brightness)
public override int CreateStaticObject(StaticObject Prototype, Vector3 Position, Transformation LocalTransformation, Matrix4D Rotate, Matrix4D Translate, double AccurateObjectDisposalZOffset, WorldProperties Properties)
{
return Program.Renderer.CreateStaticObject(Position, Prototype, LocalTransformation, Rotate, Translate, ObjectDisposalMode.Accurate, AccurateObjectDisposalZOffset, StartingDistance, EndingDistance, 25.0, TrackPosition, Brightness);
return Program.Renderer.CreateStaticObject(Position, Prototype, LocalTransformation, Rotate, Translate, ObjectDisposalMode.Accurate, AccurateObjectDisposalZOffset, Properties, 25.0);
}

public override void CreateDynamicObject(ref ObjectState internalObject)
Expand Down
2 changes: 1 addition & 1 deletion source/ObjectViewer/ProgramS.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ internal static void RefreshObjects()
{
if (CurrentHost.LoadObject(Files[i], Encoding.UTF8, out UnifiedObject o))
{
o.CreateObject(Vector3.Zero, 0.0, 0.0, 0.0);
o.CreateObject(Vector3.Zero, new WorldProperties());
}

}
Expand Down
4 changes: 2 additions & 2 deletions source/OpenBVE/Graphics/NewRenderer.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,15 +87,15 @@ public override void Initialize()
Program.FileSystem.AppendToLogFile("Renderer initialised successfully.");
}

internal int CreateStaticObject(UnifiedObject Prototype, Vector3 Position, Transformation WorldTransformation, Transformation LocalTransformation, ObjectDisposalMode AccurateObjectDisposal, double AccurateObjectDisposalZOffset, double StartingDistance, double EndingDistance, double BlockLength, double TrackPosition, double Brightness)
internal int CreateStaticObject(UnifiedObject Prototype, Vector3 Position, Transformation WorldTransformation, Transformation LocalTransformation, ObjectDisposalMode AccurateObjectDisposal, double AccurateObjectDisposalZOffset, WorldProperties Properties, double BlockLength)
{
StaticObject obj = Prototype as StaticObject;
if (obj == null)
{
Interface.AddMessage(MessageType.Error, false, "Attempted to use an animated object where only static objects are allowed.");
return -1;
}
return base.CreateStaticObject(obj, Position, WorldTransformation, LocalTransformation, AccurateObjectDisposal, AccurateObjectDisposalZOffset, StartingDistance, EndingDistance, BlockLength, TrackPosition, Brightness);
return base.CreateStaticObject(obj, Position, WorldTransformation, LocalTransformation, AccurateObjectDisposal, AccurateObjectDisposalZOffset, Properties, BlockLength);
}

public override void UpdateViewport(int Width, int Height)
Expand Down
8 changes: 4 additions & 4 deletions source/OpenBVE/System/Host.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -405,14 +405,14 @@ public override void ExecuteFunctionScript(OpenBveApi.FunctionScripting.Function
FunctionScripts.ExecuteFunctionScript(functionScript, (TrainBase)train, CarIndex, Position, TrackPosition, SectionIndex, IsPartOfTrain, TimeElapsed, CurrentState);
}

public override int CreateStaticObject(StaticObject Prototype, Vector3 Position, Transformation WorldTransformation, Transformation LocalTransformation, double AccurateObjectDisposalZOffset, double StartingDistance, double EndingDistance, double TrackPosition, double Brightness)
public override int CreateStaticObject(StaticObject Prototype, Vector3 Position, Transformation WorldTransformation, Transformation LocalTransformation, double AccurateObjectDisposalZOffset, WorldProperties Properties)
{
return Program.Renderer.CreateStaticObject(Prototype, Position, WorldTransformation, LocalTransformation, Program.CurrentRoute.AccurateObjectDisposal, AccurateObjectDisposalZOffset, StartingDistance, EndingDistance, Program.CurrentRoute.BlockLength, TrackPosition, Brightness);
return Program.Renderer.CreateStaticObject(Prototype, Position, WorldTransformation, LocalTransformation, Program.CurrentRoute.AccurateObjectDisposal, AccurateObjectDisposalZOffset, Properties, Program.CurrentRoute.BlockLength);
}

public override int CreateStaticObject(StaticObject Prototype, Vector3 Position, Transformation LocalTransformation, Matrix4D Rotate, Matrix4D Translate, double AccurateObjectDisposalZOffset, double StartingDistance, double EndingDistance, double TrackPosition, double Brightness)
public override int CreateStaticObject(StaticObject Prototype, Vector3 Position, Transformation LocalTransformation, Matrix4D Rotate, Matrix4D Translate, double AccurateObjectDisposalZOffset, WorldProperties Properties)
{
return Program.Renderer.CreateStaticObject(Position, Prototype, LocalTransformation, Rotate, Translate, Program.CurrentRoute.AccurateObjectDisposal, AccurateObjectDisposalZOffset, StartingDistance, EndingDistance, Program.CurrentRoute.BlockLength, TrackPosition, Brightness);
return Program.Renderer.CreateStaticObject(Position, Prototype, LocalTransformation, Rotate, Translate, Program.CurrentRoute.AccurateObjectDisposal, AccurateObjectDisposalZOffset, Properties, Program.CurrentRoute.BlockLength);
}

public override void CreateDynamicObject(ref ObjectState internalObject)
Expand Down
42 changes: 42 additions & 0 deletions source/OpenBveApi/Objects/Helpers/WorldProperties.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
namespace OpenBveApi.Objects
{
/// <summary>A helper struct describing the world properties of an object</summary>
public struct WorldProperties
{
/// <summary>The key of the rail on which the object is placed</summary>
public int RailKey;
/// <summary>The absolute track position at which the object is placed</summary>
public double TrackPosition;
/// <summary>The track distance at which this is displayed by the renderer</summary>
public double StartingDistance;
/// <summary>The ending distance at which this is hidden by the renderer</summary>
public double EndingDistance;
/// <summary>The brightness value of this object</summary>
public double Brightness;
/// <summary>The index of the signalling section this object is attached to</summary>
public int SectionIndex;

/// <summary>Creates a new instance of this struct</summary>
public WorldProperties(int railKey, double trackPosition, double startingDistance, double endingDistance, int sectionIndex = -1, double brightness = 1.0)
{
RailKey = railKey;
TrackPosition = trackPosition;
StartingDistance = startingDistance;
EndingDistance = endingDistance;
Brightness = brightness;
SectionIndex = sectionIndex;
}

/// <summary>Creates a new instance of this struct</summary>
public WorldProperties(double trackPosition, int sectionIndex, double brightness)
{
RailKey = 0;
TrackPosition = trackPosition;
SectionIndex = sectionIndex;
Brightness = brightness;
// Mechanik visibility- not used
StartingDistance = 0;
EndingDistance = 0;
}
}
}
33 changes: 17 additions & 16 deletions source/OpenBveApi/Objects/ObjectTypes/AnimatedObject.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -732,14 +732,15 @@ public void Update(AbstractTrain Train, int CarIndex, double TrackPosition, Vect
}
}

/// <summary>Creates the animated object within the game world</summary>
/// <param name="Position">The absolute position</param>
/// <param name="WorldTransformation">The world transformation to apply (e.g. ground, rail)</param>
/// <param name="LocalTransformation">The local transformation to apply in order to rotate the model</param>
/// <param name="sectionIndex">The index of the section if placed using a SigF command</param>
/// <param name="TrackPosition">The absolute track position</param>
/// <param name="Brightness">The brightness value at the track position</param>
public void CreateObject(Vector3 Position, Transformation WorldTransformation, Transformation LocalTransformation, int sectionIndex, double TrackPosition, double Brightness)
/// <summary>Creates the animated object within the game world</summary>
/// <param name="Position">The absolute position</param>
/// <param name="WorldTransformation">The world transformation to apply (e.g. ground, rail)</param>
/// <param name="LocalTransformation">The local transformation to apply in order to rotate the model</param>
/// <param name="sectionIndex">The index of the section if placed using a SigF command</param>
/// <param name="railIndex">The rail index the object is placed on</param>
/// <param name="TrackPosition">The absolute track position</param>
/// <param name="Brightness">The brightness value at the track position</param>
public void CreateObject(Vector3 Position, Transformation WorldTransformation, Transformation LocalTransformation, WorldProperties Properties)
{

int a = currentHost.AnimatedWorldObjectsUsed;
Expand All @@ -757,11 +758,11 @@ public void CreateObject(Vector3 Position, Transformation WorldTransformation, T
Up = FinalTransformation.Y,
Side = FinalTransformation.X,
Object = o,
TrackPosition = TrackPosition,
TrackPosition = Properties.TrackPosition,
};

currentObject.FrontAxleFollower.TrackPosition = TrackPosition + FrontAxlePosition;
currentObject.RearAxleFollower.TrackPosition = TrackPosition + RearAxlePosition;
currentObject.FrontAxleFollower.TrackPosition = Properties.TrackPosition + FrontAxlePosition;
currentObject.RearAxleFollower.TrackPosition = Properties.TrackPosition + RearAxlePosition;
currentObject.FrontAxlePosition = FrontAxlePosition;
currentObject.RearAxlePosition = RearAxlePosition;
currentObject.FrontAxleFollower.UpdateWorldCoordinates(false);
Expand All @@ -774,7 +775,7 @@ public void CreateObject(Vector3 Position, Transformation WorldTransformation, T
}
}

currentObject.Object.internalObject.Brightness = Brightness;
currentObject.Object.internalObject.Brightness = Properties.Brightness;

double r = 0.0;
for (int i = 0; i < currentObject.Object.States.Length; i++)
Expand All @@ -795,16 +796,16 @@ public void CreateObject(Vector3 Position, Transformation WorldTransformation, T
{
var o = this.Clone();
currentHost.CreateDynamicObject(ref o.internalObject);
o.SectionIndex = sectionIndex;
o.SectionIndex = Properties.SectionIndex;
AnimatedWorldObject currentObject = new AnimatedWorldObject(currentHost)
{
Position = Position,
Direction = FinalTransformation.Z,
Up = FinalTransformation.Y,
Side = FinalTransformation.X,
Object = o,
SectionIndex = sectionIndex,
TrackPosition = TrackPosition,
SectionIndex = Properties.SectionIndex,
TrackPosition = Properties.TrackPosition,
};
for (int i = 0; i < currentObject.Object.States.Length; i++)
{
Expand All @@ -814,7 +815,7 @@ public void CreateObject(Vector3 Position, Transformation WorldTransformation, T
}
}

currentObject.Object.internalObject.Brightness = Brightness;
currentObject.Object.internalObject.Brightness = Properties.Brightness;

double r = 0.0;
for (int i = 0; i < currentObject.Object.States.Length; i++)
Expand Down
13 changes: 6 additions & 7 deletions source/OpenBveApi/Objects/ObjectTypes/AnimatedObjectCollection.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ public AnimatedObjectCollection(HostInterface Host)

/// <inheritdoc/>
public override void CreateObject(Vector3 Position, Transformation WorldTransformation, Transformation LocalTransformation,
int SectionIndex, double StartingDistance, double EndingDistance,
double TrackPosition, double Brightness, bool DuplicateMaterials = false)
WorldProperties Properties, bool DuplicateMaterials = false)
{
bool[] free = new bool[Objects.Length];
bool anyfree = false;
Expand Down Expand Up @@ -67,11 +66,11 @@ public override void CreateObject(Vector3 Position, Transformation WorldTransfor
mat *= transformationMatrix;
double zOffset = Objects[i].States[0].Translation.ExtractTranslation().Z * -1.0; //To calculate the Z-offset within the object, we want the untransformed co-ordinates, not the world co-ordinates

currentHost.CreateStaticObject(Objects[i].States[0].Prototype, Position, LocalTransformation, mat, Matrix4D.CreateTranslation(Position.X, Position.Y, -Position.Z), zOffset, StartingDistance, EndingDistance, TrackPosition, Brightness);
currentHost.CreateStaticObject(Objects[i].States[0].Prototype, Position, LocalTransformation, mat, Matrix4D.CreateTranslation(Position.X, Position.Y, -Position.Z), zOffset, Properties);
}
else
{
Objects[i].CreateObject(Position, WorldTransformation, LocalTransformation, SectionIndex, TrackPosition, Brightness);
Objects[i].CreateObject(Position, WorldTransformation, LocalTransformation, Properties);
}
}
}
Expand All @@ -82,7 +81,7 @@ public override void CreateObject(Vector3 Position, Transformation WorldTransfor
{
if (Objects[i].States.Length != 0)
{
Objects[i].CreateObject(Position, WorldTransformation, LocalTransformation, SectionIndex, TrackPosition, Brightness);
Objects[i].CreateObject(Position, WorldTransformation, LocalTransformation, Properties);
}
}
}
Expand All @@ -100,8 +99,8 @@ public override void CreateObject(Vector3 Position, Transformation WorldTransfor
Vector3 v = Sounds[i].Position;
v.Rotate(LocalTransformation);
v.Rotate(WorldTransformation);
(Sounds[i] as WorldSound)?.CreateSound(Position + v, WorldTransformation, LocalTransformation, SectionIndex, TrackPosition);
(Sounds[i] as AnimatedWorldObjectStateSound)?.Create(Position + v, WorldTransformation, LocalTransformation, SectionIndex, TrackPosition, Brightness);
(Sounds[i] as WorldSound)?.CreateSound(Position + v, WorldTransformation, LocalTransformation, Properties);
(Sounds[i] as AnimatedWorldObjectStateSound)?.Create(Position + v, WorldTransformation, LocalTransformation, Properties);
}
}

Expand Down
Loading

0 comments on commit 8f543c6

Please sign in to comment.