Cogs.Core
Static Public Member Functions | Public Attributes | List of all members
Cogs::Core::InstancedMeshBuilderComponent Class Reference

#include <InstancedMeshBuilderComponent.h>

Inheritance diagram for Cogs::Core::InstancedMeshBuilderComponent:
Cogs::ComponentModel::Component

Static Public Member Functions

static void registerType ()
 
- 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

std::vector< glm::vec3 > positions
 Per-instance positions, either empty or size matching the other array attributes.
 
std::vector< glm::quat > rotations
 Per-instance rotations, either empty or size matching the other array attributes.
 
std::vector< glm::vec3 > scales
 Per-instance scale factors, either empty or size matching the other array attributes.
 
std::vector< glm::vec4 > colors
 Per-instance colors, either empty or size matching the other array attributes.
 
float fixedSizeMaxDistance = 0.f
 Culling camera-distance when fixedSize is enabled. Disable by setting it to zero or negative value.
 
bool fixedSize = false
 If set, instances are dynamically scaled s.t. they appear fixed sized on screen regardles of distance from camera, the instance size is expected to be dpi-scaled pixels.
 

Additional Inherited Members

- Public Member Functions inherited from Cogs::ComponentModel::Component
class EntitygetContainer () 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 ComponentgetComponent (const Reflection::Name &name) const
 
COGSFOUNDATION_API ComponentgetComponent (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::TypegetType () 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.
 

Detailed Description

Builds instance matrices from position, rotation and scale, and can dynamically scale instances to appear fixed sized on screen.

Manages the instance mesh of the InstancedMeshRenderComponent of the same entity. Enables/disables relevant material instance variants.

Definition at line 11 of file InstancedMeshBuilderComponent.h.

Member Function Documentation

◆ registerType()

void Cogs::Core::InstancedMeshBuilderComponent::registerType ( )
static

Definition at line 7 of file InstancedMeshBuilderComponent.cpp.

Member Data Documentation

◆ colors

std::vector<glm::vec4> Cogs::Core::InstancedMeshBuilderComponent::colors

Per-instance colors, either empty or size matching the other array attributes.

Definition at line 25 of file InstancedMeshBuilderComponent.h.

◆ fixedSize

bool Cogs::Core::InstancedMeshBuilderComponent::fixedSize = false

If set, instances are dynamically scaled s.t. they appear fixed sized on screen regardles of distance from camera, the instance size is expected to be dpi-scaled pixels.

Definition at line 31 of file InstancedMeshBuilderComponent.h.

◆ fixedSizeMaxDistance

float Cogs::Core::InstancedMeshBuilderComponent::fixedSizeMaxDistance = 0.f

Culling camera-distance when fixedSize is enabled. Disable by setting it to zero or negative value.

Definition at line 28 of file InstancedMeshBuilderComponent.h.

◆ positions

std::vector<glm::vec3> Cogs::Core::InstancedMeshBuilderComponent::positions

Per-instance positions, either empty or size matching the other array attributes.

Definition at line 16 of file InstancedMeshBuilderComponent.h.

◆ rotations

std::vector<glm::quat> Cogs::Core::InstancedMeshBuilderComponent::rotations

Per-instance rotations, either empty or size matching the other array attributes.

Definition at line 19 of file InstancedMeshBuilderComponent.h.

◆ scales

std::vector<glm::vec3> Cogs::Core::InstancedMeshBuilderComponent::scales

Per-instance scale factors, either empty or size matching the other array attributes.

Definition at line 22 of file InstancedMeshBuilderComponent.h.


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