Inheritance diagram for Cogs::Core::EchoSounder::BeamGroupComponent:

Public Member Functions
void	initialize (Context *context)

void	update ()

void	requestCallback (std::function< void(Context *)> func)
	Used by OctProviderSystem to get a hook.

Public Member Functions inherited from Cogs::ComponentModel::Component
class Entity *	getContainer () const
	Get the container currently owning this component instance.

void	setContainer (class Entity *container)
	Set the container owning this component instance.

template<typename ComponentType >
ComponentType *	getComponent () const

COGSFOUNDATION_API Component *	getComponent (const Reflection::Name &name) const

COGSFOUNDATION_API Component *	getComponent (const Reflection::TypeId &id) const

template<typename ComponentType >
ComponentHandle	getComponentHandle () const

COGSFOUNDATION_API ComponentHandle	getComponentHandle (const Reflection::Name &name) const

COGSFOUNDATION_API ComponentHandle	getComponentHandle (const Reflection::TypeId &id) const

void	setActive ()
	Sets the component to the ComponentFlags::Active state.

bool	isActive () const
	Gets if the component is currently set to the ComponentFlags::Active state.

void	setChanged ()
	Sets the component to the ComponentFlags::Changed state with carry.

void	setChangedTransient ()
	Sets the component to the ComponentFlags::Changed state without carry.

void	setFieldChanged (const Reflection::FieldId fieldId)
	Sets the component to the ComponentFlags::Changed state without carry.

template<typename ClassType , typename FieldType >
void	setFieldChanged (FieldType ClassType::*field)
	Sets a flag indicating that the given field has changed.

void	setFieldChangedTransient (const Reflection::FieldId fieldId)
	Sets the component to the ComponentFlags::Changed state without carry.

bool	hasChanged () const

bool	hasAnyfieldChanged () const
	Gets if any fields have been changed.

bool	hasFieldChanged (const Reflection::FieldId fieldId) const
	Gets if the field with the given id on this component instance has changed.

template<typename ClassType , typename FieldType >
bool	hasFieldChanged (FieldType ClassType::*field) const
	Gets if the given field has changed.

void	resetCarryChanged ()
	Reset the CarryChanged flag. Called at start of redraw. See ComponentFlags::CarryChanged.

void	resetChanged ()
	Resets the changed state of the component, respecting any carry state set.

template<typename ClassType , typename FieldType >
Reflection::FieldId	getFieldId (FieldType ClassType::*field) const
	Gets field ID of the given field.

void	resetFieldsChanged ()
	Resets the state of all changed field flags.

void	resetFieldChanged (const Reflection::FieldId fieldId)
	Resets the changed state of the given fieldId.

template<typename ClassType , typename FieldType >
void	resetFieldChanged (FieldType ClassType::*field)
	Resets the changed state of the given field.

constexpr void	setFlags (const uint32_t flags)
	Override all flags of the Component, setting the given flags.

constexpr void	setFlag (const uint32_t flag)
	Set the given flags. Does not override the currently set flags.

constexpr void	unsetFlag (const uint32_t flag)
	Unset the given flag. Does not remove the status of other than the given flags.

constexpr bool	isSet (const uint32_t flag) const
	Checks if the given flag is set. Requires exact bit match if test of several bits.

constexpr void	setTypeId (const Reflection::TypeId typeId)
	Set the Reflection::TypeId of the component.

constexpr Reflection::TypeId	getTypeId () const
	Get the Reflection::TypeId of the component.

COGSFOUNDATION_API const Reflection::Type &	getType () const
	Get the full Reflection::Type of the component.

constexpr void	setIndex (const ComponentIndex index)
	Set the components pool index. For internal use only.

constexpr ComponentIndex	getIndex () const
	Get the components pool index. For internal use only.

constexpr void	setGeneration (uint16_t generation)
	Sets the component generation.

constexpr uint16_t	getGeneration () const
	Gets the component generation.

size_t	hash (size_t hashValue=Cogs::hash()) const
	Calculates a hash of this component's members.

Static Public Member Functions
static void	registerType ()

Static Public Member Functions inherited from Cogs::Core::DynamicComponent
static COGSCORE_DLL_API void	registerType ()
	Register the type in the type system.

template<typename T >
static Reflection::Type &	registerDerivedType ()
	Convenience method for registering the type of a derived component.

Static Public Member Functions inherited from Cogs::ComponentModel::Component
static COGSFOUNDATION_API void	registerType ()
	Register the Component type in the global type database.

static COGSFOUNDATION_API Reflection::TypeId	getComponentTypeId (const StringView &name)
	Get the type id of the component type with the given name.

Public Attributes
bool	sane = false

uint32_t	gen = 1

Topology	topology = Topology::SingleBeam

uint32_t	majorCount = 0

uint32_t	minorCount = 0

std::vector< uint32_t >	beams

std::vector< float >	directionX
	Subset of directions, maintained by BeamGroupComponent::update.

std::vector< float >	directionY
	Subset of directions, maintained by BeamGroupComponent::update.

float	minDirectionX = 0.0f
	Maintained by BeamGroupComponent::update.

float	maxDirectionX = 0.0f
	Maintained by BeamGroupComponent::update.

float	minDirectionY = 0.0f
	Maintained by BeamGroupComponent::update.

float	maxDirectionY = 0.0f
	Maintained by BeamGroupComponent::update.

float	maxBeamWidthX = 0.0f
	Maintained by BeamGroupComponent::update.

float	maxBeamWidthY = 0.0f
	Maintained by BeamGroupComponent::update.

float	minDistance = 0.0f
	Along ray, maintained by BeamGroupComponent::update.

float	maxDistance = 0.0f
	Along ray, maintained by BeamGroupComponent::update.

bool	minorClosed = false
	Maintained by BeamGroupComponent::update.

Public Attributes inherited from Cogs::Core::DynamicComponent
void *	messageCallback = nullptr

void *	userData = nullptr

size_t	dynamicTypeInfoIndex = static_cast<size_t>(-1)

Private Attributes
Context *	context = nullptr

DataSetComponent *	dataComp_ = nullptr

uint32_t	dataConfGen = 0

uint32_t	majorCount_ = 0

uint32_t	minorCount_ = 0

std::vector< uint32_t >	beams_

std::function< void(Context *)>	callback

Detailed Description

Definition at line 26 of file BeamGroupComponent.h.

Member Function Documentation

◆ initialize()

void BeamGroupComponent::initialize ( Context * context )

Definition at line 42 of file BeamGroupComponent.cpp.

◆ registerType()

void BeamGroupComponent::registerType ( )

static

Definition at line 14 of file BeamGroupComponent.cpp.

◆ requestCallback()

void Cogs::Core::EchoSounder::BeamGroupComponent::requestCallback ( std::function< void(Context *)> func )

inline

Used by OctProviderSystem to get a hook.

Definition at line 35 of file BeamGroupComponent.h.

◆ update()

void BeamGroupComponent::update ( )

Definition at line 47 of file BeamGroupComponent.cpp.

Member Data Documentation

◆ beams

std::vector<uint32_t> Cogs::Core::EchoSounder::BeamGroupComponent::beams

Definition at line 44 of file BeamGroupComponent.h.

◆ beams_

std::vector<uint32_t> Cogs::Core::EchoSounder::BeamGroupComponent::beams_

private

Definition at line 65 of file BeamGroupComponent.h.

◆ callback

std::function<void(Context*)> Cogs::Core::EchoSounder::BeamGroupComponent::callback

private

Definition at line 66 of file BeamGroupComponent.h.

◆ context

Context* Cogs::Core::EchoSounder::BeamGroupComponent::context = nullptr

private

Definition at line 60 of file BeamGroupComponent.h.

◆ dataComp_

DataSetComponent* Cogs::Core::EchoSounder::BeamGroupComponent::dataComp_ = nullptr

private

Definition at line 61 of file BeamGroupComponent.h.

◆ dataConfGen

uint32_t Cogs::Core::EchoSounder::BeamGroupComponent::dataConfGen = 0

private

Definition at line 62 of file BeamGroupComponent.h.

◆ directionX

std::vector<float> Cogs::Core::EchoSounder::BeamGroupComponent::directionX

Subset of directions, maintained by BeamGroupComponent::update.

Definition at line 46 of file BeamGroupComponent.h.

◆ directionY

std::vector<float> Cogs::Core::EchoSounder::BeamGroupComponent::directionY

Subset of directions, maintained by BeamGroupComponent::update.

Definition at line 47 of file BeamGroupComponent.h.

◆ gen

uint32_t Cogs::Core::EchoSounder::BeamGroupComponent::gen = 1

Definition at line 38 of file BeamGroupComponent.h.

◆ majorCount

uint32_t Cogs::Core::EchoSounder::BeamGroupComponent::majorCount = 0

Definition at line 42 of file BeamGroupComponent.h.

◆ majorCount_

uint32_t Cogs::Core::EchoSounder::BeamGroupComponent::majorCount_ = 0

private

Definition at line 63 of file BeamGroupComponent.h.

◆ maxBeamWidthX

float Cogs::Core::EchoSounder::BeamGroupComponent::maxBeamWidthX = 0.0f

Maintained by BeamGroupComponent::update.

Definition at line 52 of file BeamGroupComponent.h.

◆ maxBeamWidthY

float Cogs::Core::EchoSounder::BeamGroupComponent::maxBeamWidthY = 0.0f

Maintained by BeamGroupComponent::update.

Definition at line 53 of file BeamGroupComponent.h.

◆ maxDirectionX

float Cogs::Core::EchoSounder::BeamGroupComponent::maxDirectionX = 0.0f

Maintained by BeamGroupComponent::update.

Definition at line 49 of file BeamGroupComponent.h.

◆ maxDirectionY

float Cogs::Core::EchoSounder::BeamGroupComponent::maxDirectionY = 0.0f

Maintained by BeamGroupComponent::update.

Definition at line 51 of file BeamGroupComponent.h.

◆ maxDistance

float Cogs::Core::EchoSounder::BeamGroupComponent::maxDistance = 0.0f

Along ray, maintained by BeamGroupComponent::update.

Definition at line 55 of file BeamGroupComponent.h.

◆ minDirectionX

float Cogs::Core::EchoSounder::BeamGroupComponent::minDirectionX = 0.0f

Maintained by BeamGroupComponent::update.

Definition at line 48 of file BeamGroupComponent.h.

◆ minDirectionY

float Cogs::Core::EchoSounder::BeamGroupComponent::minDirectionY = 0.0f

Maintained by BeamGroupComponent::update.

Definition at line 50 of file BeamGroupComponent.h.

◆ minDistance

float Cogs::Core::EchoSounder::BeamGroupComponent::minDistance = 0.0f

Along ray, maintained by BeamGroupComponent::update.

Definition at line 54 of file BeamGroupComponent.h.

◆ minorClosed

bool Cogs::Core::EchoSounder::BeamGroupComponent::minorClosed = false

Maintained by BeamGroupComponent::update.

Definition at line 56 of file BeamGroupComponent.h.

◆ minorCount

uint32_t Cogs::Core::EchoSounder::BeamGroupComponent::minorCount = 0

Definition at line 43 of file BeamGroupComponent.h.

◆ minorCount_

uint32_t Cogs::Core::EchoSounder::BeamGroupComponent::minorCount_ = 0

private

Definition at line 64 of file BeamGroupComponent.h.

◆ sane

bool Cogs::Core::EchoSounder::BeamGroupComponent::sane = false

Definition at line 37 of file BeamGroupComponent.h.

◆ topology

Topology Cogs::Core::EchoSounder::BeamGroupComponent::topology = Topology::SingleBeam

Definition at line 40 of file BeamGroupComponent.h.

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

Extensions/EchoSounder/Source/Components/BeamGroupComponent.h
Extensions/EchoSounder/Source/Components/BeamGroupComponent.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ initialize()

◆ registerType()

◆ requestCallback()

◆ update()

Member Data Documentation

◆ beams

◆ beams_

◆ callback

◆ context

◆ dataComp_

◆ dataConfGen

◆ directionX

◆ directionY

◆ gen

◆ majorCount

◆ majorCount_

◆ maxBeamWidthX

◆ maxBeamWidthY

◆ maxDirectionX

◆ maxDirectionY

◆ maxDistance

◆ minDirectionX

◆ minDirectionY

◆ minDistance

◆ minorClosed

◆ minorCount

◆ minorCount_

◆ sane

◆ topology