Implements a simple checkline. More...

#include <check_line.hpp>

Inheritance diagram for CheckLine:

Public Member Functions
	CheckLine (const XMLNode &node, unsigned int index)
	Constructor for a checkline.

virtual bool	isTriggered (const Vec3 &old_pos, const Vec3 &new_pos, int indx) OVERRIDE
	True if going from old_pos to new_pos crosses this checkline.

virtual void	reset (const Track &track) OVERRIDE
	Initialises the 'previous positions' of all karts with the start position defined for this track.

virtual void	resetAfterKartMove (unsigned int kart_index) OVERRIDE

virtual void	resetAfterRewind (unsigned int kart_index) OVERRIDE

virtual void	changeDebugColor (bool is_active) OVERRIDE

virtual bool	triggeringCheckline () const OVERRIDE

void	setIgnoreHeight (bool b)
	Sets if this check line should not do a height test for testing if a line is crossed.

virtual void	saveCompleteState (BareNetworkString *bns) OVERRIDE

virtual void	restoreCompleteState (const BareNetworkString &b) OVERRIDE

const Vec3 &	getLeftPoint () const

const Vec3 &	getRightPoint () const

virtual CheckStructure *	clone () OVERRIDE
	Clone to child process for server usage (atm no sound or scripting).

Public Member Functions inherited from CheckStructure
	CheckStructure (const XMLNode &node, unsigned int index)

virtual void	update (float dt)
	Updates all check structures.

virtual void	resetAfterKartMove (unsigned int kart_index)

virtual void	resetAfterRewind (unsigned int kart_index)

virtual void	changeDebugColor (bool is_active)

virtual bool	isTriggered (const Vec3 &old_pos, const Vec3 &new_pos, int indx)=0
	True if going from old_pos to new_pos crosses this checkline.

virtual void	trigger (unsigned int kart_index)
	Is called when this check structure is triggered.

virtual void	reset (const Track &track)
	Initialises the 'previous positions' of all karts with the start position defined for this track.

CheckType	getType () const
	Returns the type of this check structure.

void	addSuccessor (unsigned int i)
	Adds the index of a successor check structure which will get triggered by this check structure.

virtual bool	triggeringCheckline () const

virtual void	saveCompleteState (BareNetworkString *bns)

virtual void	restoreCompleteState (const BareNetworkString &b)

void	saveIsActive (int kart_id, BareNetworkString *bns)

void	restoreIsActive (int kart_id, const BareNetworkString &b)

int	getIndex () const

virtual CheckStructure *	clone ()=0
	Clone to child process for server usage (atm no sound or scripting).

Private Attributes
bool	m_ignore_height
	True if this line should ignore the height test.

Vec3	m_left_point
	The actual (or estimated) left and right end points in 3d.

Vec3	m_right_point

std::vector< bool >	m_previous_sign
	Stores the sign (i.e.

std::shared_ptr< SP::SPDynamicDrawCall >	m_debug_dy_dc
	Used to display debug information about checklines.

irr::core::triangle3df	m_check_plane [4]
	The planes that are tested for being crossed.

Additional Inherited Members
Public Types inherited from CheckStructure
enum	CheckType { CT_NEW_LAP , CT_ACTIVATE , CT_TOGGLE , CT_CANNON , CT_GOAL , CT_AMBIENT_SPHERE , CT_TRIGGER }
	Different types of check structures: ACTIVATE: Activates another check structure (independent of the state that check structure is in) TOGGLE: Switches (inverts) the state of another check structure. More...

Protected Member Functions inherited from CheckStructure
	CheckStructure ()
	For CheckTrigger or CheckCylinder.

Protected Attributes inherited from CheckStructure
AlignedArray< Vec3 >	m_previous_position
	Stores the previous position of all karts.

std::vector< bool >	m_is_active
	Stores if this check structure is active (for a given kart).

bool	m_active_at_reset
	True if this check structure should be activated at a reset.

unsigned int	m_index
	Stores the index of this check structure.

Detailed Description

Implements a simple checkline.

It's a finite line with 2 endpoints in 2d and a minimum height (i.e. the minimum Y coordinate of the two points). If a kart crosses the line (in the projection on the 2d plane) and has an appropriate height, the checkline will be triggered. This allows for very easy checking of checklines, and should be sufficient for most check structure.

Constructor & Destructor Documentation

◆ CheckLine()

CheckLine::CheckLine	(	const XMLNode &	node,
		unsigned int	index
	)

Constructor for a checkline.

Parameters

node	XML node containing the parameters for this checkline.
index	Index of this check structure in the check manager.

Member Function Documentation

◆ changeDebugColor()

void CheckLine::changeDebugColor ( bool is_active )

virtual

Reimplemented from CheckStructure.

Reimplemented in CheckCannon.

◆ clone()

virtual CheckStructure * CheckLine::clone ( )

inlinevirtual

Clone to child process for server usage (atm no sound or scripting).

Implements CheckStructure.

Reimplemented in CheckCannon.

◆ isTriggered()

bool CheckLine::isTriggered	(	const Vec3 &	old_pos,
		const Vec3 &	new_pos,
		int	kart_index
	)

virtual

True if going from old_pos to new_pos crosses this checkline.

This function is called from update (of the checkline structure).

Parameters

old_pos	Position in previous frame.
new_pos	Position in current frame.
kart_indx	Index of the kart, can be used to store kart specific additional data. If set to a negative number it will be ignored (used for e.g. soccer ball, and basket ball).

Implements CheckStructure.

◆ reset()

void CheckLine::reset ( const Track & track )

virtual

Initialises the 'previous positions' of all karts with the start position defined for this track.

Parameters

track The track object defining the start positions.

Reimplemented from CheckStructure.

◆ resetAfterKartMove()

void CheckLine::resetAfterKartMove ( unsigned int kart_index )

virtual

Reimplemented from CheckStructure.

◆ resetAfterRewind()

virtual void CheckLine::resetAfterRewind ( unsigned int kart_index )

inlinevirtual

Reimplemented from CheckStructure.

◆ restoreCompleteState()

void CheckLine::restoreCompleteState ( const BareNetworkString & b )

virtual

Reimplemented from CheckStructure.

◆ saveCompleteState()

void CheckLine::saveCompleteState ( BareNetworkString * bns )

virtual

Reimplemented from CheckStructure.

◆ setIgnoreHeight()

void CheckLine::setIgnoreHeight ( bool b )

inline

Sets if this check line should not do a height test for testing if a line is crossed.

Used for basket calls in cannon (the ball can be too heigh to otherwise trigger he cannon).

◆ triggeringCheckline()

virtual bool CheckLine::triggeringCheckline ( ) const

inlinevirtual

Reimplemented from CheckStructure.

Member Data Documentation

◆ m_ignore_height

bool CheckLine::m_ignore_height

private

True if this line should ignore the height test.

This is required e.g. for basketball cannons, since the ball can be too high to otherwise trigger the cannon.

◆ m_left_point

Vec3 CheckLine::m_left_point

private

The actual (or estimated) left and right end points in 3d.

This is used by the cannon. If the xml file stores only the min_height, those points are set from the 2d points and the min height.

◆ m_previous_sign

std::vector<bool> CheckLine::m_previous_sign

private

Stores the sign (i.e.

side) of the previous line to save some computations. True if the value is >=0, i.e. the point is on or to the right of the line.

The documentation for this class was generated from the following files:

tracks/check_line.hpp
tracks/check_line.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CheckLine()

Member Function Documentation

◆ changeDebugColor()

◆ clone()

◆ isTriggered()

◆ reset()

◆ resetAfterKartMove()

◆ resetAfterRewind()

◆ restoreCompleteState()

◆ saveCompleteState()

◆ setIgnoreHeight()

◆ triggeringCheckline()

Member Data Documentation

◆ m_ignore_height

◆ m_left_point

◆ m_previous_sign