#include <KColData.hh>

Description

Performs lookups for KCL triangles.

Definition at line 57 of file KColData.hh.

Classes
struct	KCollisionPrism

Public Types
enum class	CollisionCheckType { Edge , Plane , Movement }

Public Member Functions
	STATIC_ASSERT (sizeof(KCollisionPrism)==0x10)

	KColData (const void *file)

void	narrowScopeLocal (const EGG::Vector3f &pos, f32 radius, KCLTypeMask mask)

void	narrowPolygon_EachBlock (const u16 *prismArray)

void	computeBBox ()
	Calculates a EGG::BoundBox3f that describes the boundary of the track's KCL.

bool	checkPointCollision (f32 distOut, EGG::Vector3f fnrmOut, u16 *flagsOut)

bool	checkSphereCollision (f32 distOut, EGG::Vector3f fnrmOut, u16 *flagsOut)

bool	checkSphere (f32 distOut, EGG::Vector3f fnrmOut, u16 *flagsOut)
	Iterates the list of looked-up triangles to see if we are colliding.

bool	checkSphereSingle (f32 distOut, EGG::Vector3f fnrmOut, u16 *flagsOut)

void	lookupPoint (const EGG::Vector3f &pos, const EGG::Vector3f &prevPos, KCLTypeMask typeMask)
	Sets members in preparation of a subsequent point collision check call.

void	lookupSphere (f32 radius, const EGG::Vector3f &pos, const EGG::Vector3f &prevPos, KCLTypeMask typeMask)
	Sets members in preparation of a subsequent sphere collision check call.

void	lookupSphereCached (const EGG::Vector3f &p1, const EGG::Vector3f &p2, u32 typeMask, f32 radius)

const u16 *	searchBlock (const EGG::Vector3f &pos)
	Finds the data block corresponding to the provided position.

Static Public Member Functions
static EGG::Vector3f	GetVertex (f32 height, const EGG::Vector3f &vertex1, const EGG::Vector3f &fnrm, const EGG::Vector3f &enrm3, const EGG::Vector3f &enrm)
	Computes a prism vertex based off of the triangle's normal vectors.

Getters

const EGG::BoundBox3f &	bbox () const

u16	prismCache (u32 idx) const

Private Member Functions
void	preloadPrisms ()
	Creates a copy of the prisms in memory.

void	preloadNormals ()
	Creates a copy of the normals in memory.

void	preloadVertices ()
	Creates a copy of the vertices in memory.

bool	checkCollision (const KCollisionPrism &prism, f32 distOut, EGG::Vector3f fnrmOut, u16 *flagsOut, CollisionCheckType type)
	This is a combination of the three collision checks in the base game.

bool	checkPointCollision (const KCollisionPrism &prism, f32 distOut, EGG::Vector3f fnrmOut, u16 *flagsOut, bool movement)
	This is a combination of two point collision check functions. They only vary based on whether we are checking movement.

bool	checkSphereMovement (f32 distOut, EGG::Vector3f fnrmOut, u16 *attributeOut)
	Iterates the local data block to check for directional collision.

bool	checkPointMovement (f32 distOut, EGG::Vector3f fnrmOut, u16 *attributeOut)

bool	checkPoint (f32 distOut, EGG::Vector3f fnrmOut, u16 *attributeOut)

Private Attributes
const void *	m_posData

const void *	m_nrmData

const void *	m_prismData

const void *	m_blockData

f32	m_prismThickness

EGG::Vector3f	m_areaMinPos

u32	m_areaXWidthMask
	The x dimension of the octree's bounding box.

u32	m_areaYWidthMask
	The y dimension of the octree's bounding box.

u32	m_areaZWidthMask
	The z dimension of the octree's bounding box.

u32	m_blockWidthShift
	Used to initialize octree navigation.

u32	m_areaXBlocksShift
	Used to initialize octree navigation.

u32	m_areaXYBlocksShift
	Used to initialize octree navigation.

f32	m_sphereRadius
	Clamps the sphere we check collision against.

EGG::Vector3f	m_pos

EGG::Vector3f	m_prevPos

EGG::Vector3f	m_movement

f32	m_radius

KCLTypeMask	m_typeMask

const u16 *	m_prismIter

EGG::BoundBox3f	m_bbox

std::array< u16, 256 >	m_prismCache

u16 *	m_prismCacheTop

u16 *	m_cachedPrismArray

EGG::Vector3f	m_cachedPos

f32	m_cachedRadius

std::span< KCollisionPrism >	m_prisms
	Optimizes for time by avoiding unnecessary byteswapping. The Wii doesn't have this problem because big endian is always assumed.

std::span< EGG::Vector3f >	m_nrms

std::span< EGG::Vector3f >	m_vertices

Member Enumeration Documentation

◆ CollisionCheckType

enum class Field::KColData::CollisionCheckType

strong

Definition at line 59 of file KColData.hh.

Constructor & Destructor Documentation

◆ KColData()

Field::KColData::KColData ( const void * file )

0x807BDC5C

Definition at line 14 of file KColData.cc.

◆ ~KColData()

Field::KColData::~KColData ( )

Definition at line 56 of file KColData.cc.

Member Function Documentation

◆ bbox()

const EGG::BoundBox3f & Field::KColData::bbox ( ) const

inlinenodiscard

Definition at line 101 of file KColData.hh.

◆ checkCollision()

bool Field::KColData::checkCollision	(	const KCollisionPrism &	prism,
		f32 *	distOut,
		EGG::Vector3f *	fnrmOut,
		u16 *	flagsOut,
		CollisionCheckType	type )

nodiscardprivate

This is a combination of the three collision checks in the base game.

The checks vary only by a few if-statements, related to whether we are checking for:

A collision with at least the triangle edge (0x807C0F00)
A collision with the triangle plane (0x807C1514)
A collision such that we are inside the triangle (0x807C0884)

Definition at line 365 of file KColData.cc.

◆ checkPoint()

bool Field::KColData::checkPoint	(	f32 *	distOut,
		EGG::Vector3f *	fnrmOut,
		u16 *	attributeOut )

nodiscardprivate0x807C21F4

Definition at line 635 of file KColData.cc.

◆ checkPointCollision() [1/2]

bool Field::KColData::checkPointCollision	(	const KCollisionPrism &	prism,
		f32 *	distOut,
		EGG::Vector3f *	fnrmOut,
		u16 *	flagsOut,
		bool	movement )

nodiscardprivate

This is a combination of two point collision check functions. They only vary based on whether we are checking movement.

Definition at line 552 of file KColData.cc.

◆ checkPointCollision() [2/2]

bool Field::KColData::checkPointCollision	(	f32 *	distOut,
		EGG::Vector3f *	fnrmOut,
		u16 *	flagsOut )

nodiscard0x807C1F80

Definition at line 121 of file KColData.cc.

◆ checkPointMovement()

bool Field::KColData::checkPointMovement	(	f32 *	distOut,
		EGG::Vector3f *	fnrmOut,
		u16 *	attributeOut )

nodiscardprivate0x807C1F80

Definition at line 655 of file KColData.cc.

◆ checkSphere()

bool Field::KColData::checkSphere	(	f32 *	distOut,
		EGG::Vector3f *	fnrmOut,
		u16 *	flagsOut )

nodiscard0x807C1514

Iterates the list of looked-up triangles to see if we are colliding.

Parameters

distOut	If colliding, returns the distance between the player and the triangle
fnrmOut	If colliding, returns the floor normal of the triangle
flagsOut	If colliding, returns the KCL attributes for that triangle

Returns: whether or not the player is colliding with the triangle

Definition at line 138 of file KColData.cc.

◆ checkSphereCollision()

bool Field::KColData::checkSphereCollision	(	f32 *	distOut,
		EGG::Vector3f *	fnrmOut,
		u16 *	flagsOut )

nodiscard0x807C2410

Definition at line 127 of file KColData.cc.

◆ checkSphereMovement()

bool Field::KColData::checkSphereMovement	(	f32 *	distOut,
		EGG::Vector3f *	fnrmOut,
		u16 *	attributeOut )

nodiscardprivate0x807C0884

Iterates the local data block to check for directional collision.

Parameters

distOut	If colliding, returns the distance between the player and the tri
fnrmOut	If colliding, returns the floor normal of the triangle
attributeOut	If colliding, returns the KCL attributes for that triangle

Returns: Whether or not a collision has occurred

Definition at line 615 of file KColData.cc.

◆ checkSphereSingle()

bool Field::KColData::checkSphereSingle	(	f32 *	distOut,
		EGG::Vector3f *	fnrmOut,
		u16 *	flagsOut )

nodiscard0x807C0F00

Definition at line 158 of file KColData.cc.

◆ computeBBox()

void Field::KColData::computeBBox ( )

0x807BDDFC

Calculates a EGG::BoundBox3f that describes the boundary of the track's KCL.

Definition at line 96 of file KColData.cc.

◆ GetVertex()

EGG::Vector3f Field::KColData::GetVertex	(	f32	height,
		const EGG::Vector3f &	vertex1,
		const EGG::Vector3f &	fnrm,
		const EGG::Vector3f &	enrm3,
		const EGG::Vector3f &	enrm )

staticnodiscard0x807BDF54

Computes a prism vertex based off of the triangle's normal vectors.

Triangle Vertices Formula: Given a triangle with vertices \(\vec{A}, \vec{B}, \vec{C}\), face normal \(\hat{f}\), and height \(h\), label the edge normals by: \begin{aligned}\hat{en}_1 := e_{AB}, \,\, \hat{en}_2:= e_{AC}, \,\,\hat{en}_3:=e_{BC} \end{aligned} We can recover \(\vec{B}, \vec{C}\) via: \begin{aligned} \vec{B} = \vec{A} + \dfrac{h}{(\hat{en}_2 \times \hat{f}) \cdot \hat{en}_3}\left(\hat{en}_2 \times \hat{f}\right), \, \, \vec{C} = \vec{A} + \dfrac{h}{(\hat{en}_1 \times \hat{f}) \cdot \hat{en}_3}(\hat{en}_1 \times \hat{f}) \, . \end{aligned}

Definition at line 292 of file KColData.cc.

◆ lookupPoint()

void Field::KColData::lookupPoint	(	const EGG::Vector3f &	pos,
		const EGG::Vector3f &	prevPos,
		KCLTypeMask	typeMask )

0x807C1B0C

Sets members in preparation of a subsequent point collision check call.

Definition at line 189 of file KColData.cc.

◆ lookupSphere()

void Field::KColData::lookupSphere	(	f32	radius,
		const EGG::Vector3f &	pos,
		const EGG::Vector3f &	prevPos,
		KCLTypeMask	typeMask )

0x807C1BB4

Sets members in preparation of a subsequent sphere collision check call.

Definition at line 200 of file KColData.cc.

◆ lookupSphereCached()

void Field::KColData::lookupSphereCached	(	const EGG::Vector3f &	p1,
		const EGG::Vector3f &	p2,
		u32	typeMask,
		f32	radius )

0x807C1DE8

Definition at line 211 of file KColData.cc.

◆ narrowPolygon_EachBlock()

void Field::KColData::narrowPolygon_EachBlock ( const u16 * prismArray )

0x807C243C

We assume the cache has same endianness as the archive file, so do not parse out the prism index and directly store it in the cache.

Definition at line 79 of file KColData.cc.

◆ narrowScopeLocal()

void Field::KColData::narrowScopeLocal	(	const EGG::Vector3f &	pos,
		f32	radius,
		KCLTypeMask	mask )

0x807C24C0

Definition at line 63 of file KColData.cc.

◆ preloadNormals()

void Field::KColData::preloadNormals ( )

private

Creates a copy of the normals in memory.

Optimizes for time by copying all of the normals to avoid constant byteswapping. Memory cost is typically upwards of a few hundred KB, with the worst case being ~750KB.

Definition at line 331 of file KColData.cc.

◆ preloadPrisms()

void Field::KColData::preloadPrisms ( )

private

Creates a copy of the prisms in memory.

Optimizes for time by copying all of the prisms to avoid constant byteswapping. Memory cost is typically upwards of a few hundred KB, with the worst case being ~1MB.

Definition at line 304 of file KColData.cc.

◆ preloadVertices()

void Field::KColData::preloadVertices ( )

private

Creates a copy of the vertices in memory.

Optimizes for time by copying all of the vertices to avoid constant byteswapping. Memory cost is typically upwards of a few hundred KB, with the worst case being ~750KB.

Definition at line 347 of file KColData.cc.

◆ prismCache()

u16 Field::KColData::prismCache ( u32 idx ) const

inlinenodiscard

Definition at line 105 of file KColData.hh.

◆ searchBlock()

const u16 * Field::KColData::searchBlock ( const EGG::Vector3f & point )

nodiscard0x807BE030

Finds the data block corresponding to the provided position.

Parameters

point The player's position

Returns: the address of the leaf node containing the input point.

Definition at line 234 of file KColData.cc.

Member Data Documentation

◆ m_areaMinPos

EGG::Vector3f Field::KColData::m_areaMinPos

private

Definition at line 131 of file KColData.hh.

◆ m_areaXBlocksShift

u32 Field::KColData::m_areaXBlocksShift

private

Used to initialize octree navigation.

See also: searchBlock.

Definition at line 136 of file KColData.hh.

◆ m_areaXWidthMask

u32 Field::KColData::m_areaXWidthMask

private

The x dimension of the octree's bounding box.

See also: searchBlock.

Definition at line 132 of file KColData.hh.

◆ m_areaXYBlocksShift

u32 Field::KColData::m_areaXYBlocksShift

private

Used to initialize octree navigation.

See also: searchBlock.

Definition at line 137 of file KColData.hh.

◆ m_areaYWidthMask

u32 Field::KColData::m_areaYWidthMask

private

The y dimension of the octree's bounding box.

See also: searchBlock.

Definition at line 133 of file KColData.hh.

◆ m_areaZWidthMask

u32 Field::KColData::m_areaZWidthMask

private

The z dimension of the octree's bounding box.

See also: searchBlock.

Definition at line 134 of file KColData.hh.

◆ m_bbox

EGG::BoundBox3f Field::KColData::m_bbox

private

Definition at line 145 of file KColData.hh.

◆ m_blockData

const void* Field::KColData::m_blockData

private

Definition at line 129 of file KColData.hh.

◆ m_blockWidthShift

u32 Field::KColData::m_blockWidthShift

private

Used to initialize octree navigation.

See also: searchBlock.

Definition at line 135 of file KColData.hh.

◆ m_cachedPos

EGG::Vector3f Field::KColData::m_cachedPos

private

Definition at line 149 of file KColData.hh.

◆ m_cachedPrismArray

u16* Field::KColData::m_cachedPrismArray

private

Definition at line 148 of file KColData.hh.

◆ m_cachedRadius

f32 Field::KColData::m_cachedRadius

private

Definition at line 150 of file KColData.hh.

◆ m_movement

EGG::Vector3f Field::KColData::m_movement

private

Definition at line 141 of file KColData.hh.

◆ m_nrmData

const void* Field::KColData::m_nrmData

private

Definition at line 127 of file KColData.hh.

◆ m_nrms

std::span<EGG::Vector3f> Field::KColData::m_nrms

private

Definition at line 155 of file KColData.hh.

◆ m_pos

EGG::Vector3f Field::KColData::m_pos

private

Definition at line 139 of file KColData.hh.

◆ m_posData

const void* Field::KColData::m_posData

private

Definition at line 126 of file KColData.hh.

◆ m_prevPos

EGG::Vector3f Field::KColData::m_prevPos

private

Definition at line 140 of file KColData.hh.

◆ m_prismCache

std::array<u16, 256> Field::KColData::m_prismCache

private

Definition at line 146 of file KColData.hh.

◆ m_prismCacheTop

u16* Field::KColData::m_prismCacheTop

private

Definition at line 147 of file KColData.hh.

◆ m_prismData

const void* Field::KColData::m_prismData

private

Definition at line 128 of file KColData.hh.

◆ m_prismIter

const u16* Field::KColData::m_prismIter

private

Definition at line 144 of file KColData.hh.

◆ m_prisms

std::span<KCollisionPrism> Field::KColData::m_prisms

private

Optimizes for time by avoiding unnecessary byteswapping. The Wii doesn't have this problem because big endian is always assumed.

Definition at line 154 of file KColData.hh.

◆ m_prismThickness

f32 Field::KColData::m_prismThickness

private

Definition at line 130 of file KColData.hh.

◆ m_radius

f32 Field::KColData::m_radius

private

Definition at line 142 of file KColData.hh.

◆ m_sphereRadius

f32 Field::KColData::m_sphereRadius

private

Clamps the sphere we check collision against.

See also: searchBlock.

Definition at line 138 of file KColData.hh.

◆ m_typeMask

KCLTypeMask Field::KColData::m_typeMask

private

Definition at line 143 of file KColData.hh.

◆ m_vertices

std::span<EGG::Vector3f> Field::KColData::m_vertices

private

Definition at line 156 of file KColData.hh.

Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Getters

Private Member Functions

Private Attributes

Member Enumeration Documentation

◆ CollisionCheckType

Constructor & Destructor Documentation

◆ KColData()

◆ ~KColData()

Member Function Documentation

◆ bbox()

◆ checkCollision()

◆ checkPoint()

◆ checkPointCollision() [1/2]

◆ checkPointCollision() [2/2]

◆ checkPointMovement()

◆ checkSphere()

◆ checkSphereCollision()

◆ checkSphereMovement()

◆ checkSphereSingle()

◆ computeBBox()

◆ GetVertex()

◆ lookupPoint()

◆ lookupSphere()

◆ lookupSphereCached()

◆ narrowPolygon_EachBlock()

◆ narrowScopeLocal()

◆ preloadNormals()

◆ preloadPrisms()

◆ preloadVertices()

◆ prismCache()

◆ searchBlock()

Member Data Documentation

◆ m_areaMinPos

◆ m_areaXBlocksShift

◆ m_areaXWidthMask

◆ m_areaXYBlocksShift

◆ m_areaYWidthMask

◆ m_areaZWidthMask

◆ m_bbox

◆ m_blockData

◆ m_blockWidthShift

◆ m_cachedPos

◆ m_cachedPrismArray

◆ m_cachedRadius

◆ m_movement

◆ m_nrmData

◆ m_nrms

◆ m_pos

◆ m_posData

◆ m_prevPos

◆ m_prismCache

◆ m_prismCacheTop

◆ m_prismData

◆ m_prismIter

◆ m_prisms

◆ m_prismThickness

◆ m_radius

◆ m_sphereRadius

◆ m_typeMask

◆ m_vertices