Inheritance diagram for Cogs::Core::PickingBeamComponent:

Public Member Functions
void	initialize (Cogs::Core::Context *context)

void	update ()

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
glm::vec3	beamOffset = glm::vec3(0, 0, 0)
	Offset of the beam starting point relative to the parent transform.

glm::quat	beamRotation = glm::quat()
	Rotation of the beam relative to the parent transform.

glm::vec4	diffuseColor = glm::vec4(0, 0, 0.7, 0.5f)
	diffuse color of the beam and marker

glm::vec4	emissiveColor = glm::vec4(0, 0, 0.3, 1)
	emissive color of the beam and marker

bool	active = false
	whether the beam is active and should be visible and update the picked position each frame

bool	enableDepthTest = false

int32_t	transparencyLayer = 30

EntityId	lastPickedEntity = NoEntity
	Last entity picked.

glm::dvec3	lastPickedPos = glm::dvec3(0)
	World coordinates of the last raypick hit.

float	defaultPickingRadius = 4.0f
	Default distance an object can be from a ray to be considered hit.

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

void *	userData = nullptr

size_t	dynamicTypeInfoIndex = static_cast<size_t>(-1)

Detailed Description

Definition at line 14 of file PickingBeamComponent.h.

Member Function Documentation

◆ initialize()

void Cogs::Core::PickingBeamComponent::initialize ( Cogs::Core::Context * context )

Definition at line 53 of file PickingBeamComponent.cpp.

◆ registerType()

void Cogs::Core::PickingBeamComponent::registerType ( )

static

Definition at line 34 of file PickingBeamComponent.cpp.

◆ update()

void Cogs::Core::PickingBeamComponent::update ( )

Definition at line 149 of file PickingBeamComponent.cpp.

Member Data Documentation

◆ active

bool Cogs::Core::PickingBeamComponent::active = false

whether the beam is active and should be visible and update the picked position each frame

Definition at line 36 of file PickingBeamComponent.h.

◆ aimTransform

Cogs::ComponentModel::ComponentHandle Cogs::Core::PickingBeamComponent::aimTransform

private

Definition at line 68 of file PickingBeamComponent.h.

◆ beam

EntityPtr Cogs::Core::PickingBeamComponent::beam

private

Definition at line 56 of file PickingBeamComponent.h.

◆ beamCamera

Cogs::ComponentModel::ComponentHandle Cogs::Core::PickingBeamComponent::beamCamera

private

Definition at line 63 of file PickingBeamComponent.h.

◆ beamGeometryTransform

Cogs::ComponentModel::ComponentHandle Cogs::Core::PickingBeamComponent::beamGeometryTransform

private

Definition at line 67 of file PickingBeamComponent.h.

◆ beamOffset

glm::vec3 Cogs::Core::PickingBeamComponent::beamOffset = glm::vec3(0, 0, 0)

Offset of the beam starting point relative to the parent transform.

Definition at line 24 of file PickingBeamComponent.h.

◆ beamRotation

glm::quat Cogs::Core::PickingBeamComponent::beamRotation = glm::quat()

Rotation of the beam relative to the parent transform.

Definition at line 27 of file PickingBeamComponent.h.

◆ beamScene

Cogs::ComponentModel::ComponentHandle Cogs::Core::PickingBeamComponent::beamScene

private

Definition at line 64 of file PickingBeamComponent.h.

◆ context

Context* Cogs::Core::PickingBeamComponent::context = nullptr

private

Definition at line 52 of file PickingBeamComponent.h.

◆ defaultPickingRadius

float Cogs::Core::PickingBeamComponent::defaultPickingRadius = 4.0f

Default distance an object can be from a ray to be considered hit.

Definition at line 49 of file PickingBeamComponent.h.

◆ destinationMarker

EntityPtr Cogs::Core::PickingBeamComponent::destinationMarker

private

Definition at line 59 of file PickingBeamComponent.h.

◆ destinationScene

Cogs::ComponentModel::ComponentHandle Cogs::Core::PickingBeamComponent::destinationScene

private

Definition at line 65 of file PickingBeamComponent.h.

◆ destinationTransform

Cogs::ComponentModel::ComponentHandle Cogs::Core::PickingBeamComponent::destinationTransform

private

Definition at line 66 of file PickingBeamComponent.h.

◆ diffuseColor

glm::vec4 Cogs::Core::PickingBeamComponent::diffuseColor = glm::vec4(0, 0, 0.7, 0.5f)

diffuse color of the beam and marker

Definition at line 30 of file PickingBeamComponent.h.

◆ emissiveColor

glm::vec4 Cogs::Core::PickingBeamComponent::emissiveColor = glm::vec4(0, 0, 0.3, 1)

emissive color of the beam and marker

Definition at line 33 of file PickingBeamComponent.h.

◆ enableDepthTest

bool Cogs::Core::PickingBeamComponent::enableDepthTest = false

Definition at line 38 of file PickingBeamComponent.h.

◆ lastPickedEntity

EntityId Cogs::Core::PickingBeamComponent::lastPickedEntity = NoEntity

Last entity picked.

Definition at line 43 of file PickingBeamComponent.h.

◆ lastPickedPos

glm::dvec3 Cogs::Core::PickingBeamComponent::lastPickedPos = glm::dvec3(0)

World coordinates of the last raypick hit.

Definition at line 46 of file PickingBeamComponent.h.

◆ mainCamera

Cogs::ComponentModel::ComponentHandle Cogs::Core::PickingBeamComponent::mainCamera

private

Definition at line 62 of file PickingBeamComponent.h.

◆ transparencyLayer

int32_t Cogs::Core::PickingBeamComponent::transparencyLayer = 30

Definition at line 40 of file PickingBeamComponent.h.

◆ wasActive

bool Cogs::Core::PickingBeamComponent::wasActive = false

private

Definition at line 53 of file PickingBeamComponent.h.

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

Source/Components/Behavior/PickingBeamComponent.h
Source/Components/Behavior/PickingBeamComponent.cpp

Private Attributes
Context *	context = nullptr

bool	wasActive = false

EntityPtr	beam

EntityPtr	destinationMarker

Cogs::ComponentModel::ComponentHandle	mainCamera

Cogs::ComponentModel::ComponentHandle	beamCamera

Cogs::ComponentModel::ComponentHandle	beamScene

Cogs::ComponentModel::ComponentHandle	destinationScene

Cogs::ComponentModel::ComponentHandle	destinationTransform

Cogs::ComponentModel::ComponentHandle	beamGeometryTransform

Cogs::ComponentModel::ComponentHandle	aimTransform

Public Member Functions

Static Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ initialize()

◆ registerType()

◆ update()

Member Data Documentation

◆ active

◆ aimTransform

◆ beam

◆ beamCamera

◆ beamGeometryTransform

◆ beamOffset

◆ beamRotation

◆ beamScene

◆ context

◆ defaultPickingRadius

◆ destinationMarker

◆ destinationScene

◆ destinationTransform

◆ diffuseColor

◆ emissiveColor

◆ enableDepthTest

◆ lastPickedEntity

◆ lastPickedPos

◆ mainCamera

◆ transparencyLayer

◆ wasActive