AstralTransRocketries/LucidCube
1
0
Fork 0
Code Issues Pull Requests Packages Projects 1 Releases Wiki Activity

Added more documentation. Changed cTracer::Trace to return a bool instead of an int because it was only returning 1 or 0 anyways.

Browse Source
This commit is contained in:
Samuel Barney 2013-11-05 14:01:51 -07:00
parent e37531fe01
commit 9d5d74d826
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
source/Tracer.cpp
View File

@ -131,12 +131,12 @@ void cTracer::SetValues(const Vector3f & a_Start, const Vector3f & a_Direction)
int cTracer::Trace( const Vector3f & a_Start, const Vector3f & a_Direction, int a_Distance) bool cTracer::Trace( const Vector3f & a_Start, const Vector3f & a_Direction, int a_Distance)
{ {
if ((a_Start.y < 0) || (a_Start.y >= cChunkDef::Height)) if ((a_Start.y < 0) || (a_Start.y >= cChunkDef::Height))
{ {
LOGD("%s: Start Y is outside the world (%.2f), not tracing.", __FUNCTION__, a_Start.y); LOGD("%s: Start Y is outside the world (%.2f), not tracing.", __FUNCTION__, a_Start.y);
return 0; return false;
} }
SetValues(a_Start, a_Direction); SetValues(a_Start, a_Direction);
@ -157,7 +157,7 @@ int cTracer::Trace( const Vector3f & a_Start, const Vector3f & a_Direction, int
// check if first is occupied // check if first is occupied
if (pos.Equals(end1)) if (pos.Equals(end1))
{ {
return 0; return false;
} }
bool reachedX = false, reachedY = false, reachedZ = false; bool reachedX = false, reachedY = false, reachedZ = false;
@ -236,7 +236,7 @@ int cTracer::Trace( const Vector3f & a_Start, const Vector3f & a_Direction, int
return true; return true;
} }
} }
return 0; return false;
} }

11
source/Tracer.h
View File

@ -13,8 +13,8 @@ public: // tolua_export
cTracer( cWorld* a_World); // tolua_export cTracer( cWorld* a_World); // tolua_export
~cTracer(); // tolua_export ~cTracer(); // tolua_export
/// Determines if a collision occures along a line. /// Determines if a collision occures along a line. Returns true if a collision occurs.
int Trace( const Vector3f & a_Start, const Vector3f & a_Direction, int a_Distance ); // tolua_export bool Trace( const Vector3f & a_Start, const Vector3f & a_Direction, int a_Distance); // tolua_export
/// Contains the position of the block that caused the collision /// Contains the position of the block that caused the collision
Vector3f BlockHitPosition; // tolua_export Vector3f BlockHitPosition; // tolua_export
@ -26,13 +26,18 @@ public: // tolua_export
Vector3f RealHit; // tolua_export Vector3f RealHit; // tolua_export
private: private:
/// Preps Tracer object for call of Trace function. Only used internally /// Preps Tracer object for call of Trace function. Only used internally.
void SetValues( const Vector3f & a_Start, const Vector3f & a_Direction ); void SetValues( const Vector3f & a_Start, const Vector3f & a_Direction );
/// Calculates where on the block a collision occured, if it does occur /// Calculates where on the block a collision occured, if it does occur
/// Returns 0 if no intersection occured
/// Returns 1 if an intersection occured at a single point
/// Returns 2 if the line segment lies in the plane being checked
int intersect3D_SegmentPlane( const Vector3f & a_Origin, const Vector3f & a_End, const Vector3f & a_PlanePos, const Vector3f & a_PlaneNormal ); int intersect3D_SegmentPlane( const Vector3f & a_Origin, const Vector3f & a_End, const Vector3f & a_PlanePos, const Vector3f & a_PlaneNormal );
/// Determines which face on the block a collision occured, if it does occur /// Determines which face on the block a collision occured, if it does occur
/// Returns 0 if the block is air, water or no collision occured
/// Return 1 through 6 for the following block faces, repectively: -x, -z, x, z, y, -y
int GetHitNormal( const Vector3f & start, const Vector3f & end, const Vector3i & a_BlockPos); int GetHitNormal( const Vector3f & start, const Vector3f & end, const Vector3i & a_BlockPos);
float SigNum( float a_Num ); float SigNum( float a_Num );