cqsp::common::systems::commands Namespace Reference

Classes
struct	OrbitEntityTarget
struct	OrbitScalar
struct	OrbitTarget

Enumerations
enum class	Command {   CircularizeAtApoapsis , CircularizeAtPeriapsis , SetApoapsis , SetPeriapsis ,   SetInclination , MatchPlanes , CoplanarIntercept , CoplanarInterceptAndTransfer ,   Impulse , LandOnBody }
enum class	Trigger { OnEnterSOI , OnExitSOI , OnManeuver , OnCrash }

Functions
bool	VerifyCommand (Universe &universe, entt::entity command)
void	ExecuteCommand (Universe &universe, entt::entity entity, entt::entity command_entity, Command command)
bool	ProcessCommandQueue (Universe &universe, entt::entity body, Trigger trigger)
	Returns true if a command is processed and popped, returns false if not. More...
void	TransferToMoon (Universe &universe, entt::entity agent, entt::entity target)
void	PushManeuvers (Universe &universe, entt::entity entity, std::initializer_list< components::Maneuver_t > maneuver, double offset)
void	PushManeuvers (Universe &universe, entt::entity entity, components::HohmannPair_t hohmann_pair, double offset)
void	LandOnMoon (Universe &universe, entt::entity agent, entt::entity target, entt::entity city)
std::vector< entt::entity >	GetSOIHierarchy (Universe &universe, entt::entity source)
entt::entity	GetCommonSOI (Universe &universe, entt::entity source, entt::entity target)

Enumeration Type Documentation

Command

enum class cqsp::common::systems::commands::Command

strong

Enumerator
CircularizeAtApoapsis
CircularizeAtPeriapsis
SetApoapsis
SetPeriapsis
SetInclination
MatchPlanes
CoplanarIntercept
CoplanarInterceptAndTransfer
Impulse
LandOnBody

Trigger

enum class cqsp::common::systems::commands::Trigger

strong

Enumerator
OnEnterSOI
OnExitSOI
OnManeuver
OnCrash

Function Documentation

ExecuteCommand()

void cqsp::common::systems::commands::ExecuteCommand	(	Universe &	universe,
		entt::entity	entity,
		entt::entity	command_entity,
		Command	command
	)

GetCommonSOI()

entt::entity cqsp::common::systems::commands::GetCommonSOI	(	Universe &	universe,
		entt::entity	source,
		entt::entity	target
	)

Finds the common sphere of influence between the two bodies.

Parameters

universe	universe registry
source	source entity
target	target entity

Returns

least common sphere of influence between source and target. If null, then we are comparing two completely separate SOI trees.

GetSOIHierarchy()

std::vector< entt::entity > cqsp::common::systems::commands::GetSOIHierarchy	(	Universe &	universe,
		entt::entity	source
	)

LandOnMoon()

void cqsp::common::systems::commands::LandOnMoon	(	Universe &	universe,
		entt::entity	agent,
		entt::entity	target,
		entt::entity	city
	)

ProcessCommandQueue()

bool cqsp::common::systems::commands::ProcessCommandQueue	(	Universe &	universe,
		entt::entity	body,
		Trigger	trigger
	)

Returns true if a command is processed and popped, returns false if not.

PushManeuvers() [1/2]

void cqsp::common::systems::commands::PushManeuvers	(	Universe &	universe,
		entt::entity	entity,
		components::HohmannPair_t	hohmann_pair,
		double	offset
	)

PushManeuvers() [2/2]

void cqsp::common::systems::commands::PushManeuvers	(	Universe &	universe,
		entt::entity	entity,
		std::initializer_list< components::Maneuver_t >	maneuver,
		double	offset
	)

TransferToMoon()

void cqsp::common::systems::commands::TransferToMoon	(	Universe &	universe,
		entt::entity	agent,
		entt::entity	target
	)

VerifyCommand()

bool cqsp::common::systems::commands::VerifyCommand	(	Universe &	universe,
		entt::entity	command
	)

Verifies if the command is a valid ship command option. This verifies if it's not null, and contains the necessary components to make it a command