Cogs.Core
Static Public Member Functions | List of all members
Cogs::Core::SpriteRenderComponent Class Reference
Inheritance diagram for Cogs::Core::SpriteRenderComponent:
Cogs::Core::RenderComponent Cogs::ComponentModel::Component

Static Public Member Functions

static void registerType ()
 
- Static Public Member Functions inherited from Cogs::Core::RenderComponent
static void registerType ()
 Register the type in the type system.
 
- 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.
 

Additional Inherited Members

- Public Member Functions inherited from Cogs::Core::RenderComponent
constexpr void setRenderFlag (RenderFlags flag)
 Sets the given flag.
 
constexpr void setRenderFlag (RenderFlags flag, bool status)
 Set the given flag to the given status.
 
constexpr void unsetRenderFlag (RenderFlags flag)
 Unset the given flag.
 
constexpr bool isRenderFlagSet (RenderFlags flag) const
 Check if the given flag is currently set.
 
constexpr bool isRenderFlagsSet (RenderFlags flags) const
 Check if the given combination of flags are set.
 
constexpr void setVisible (bool visible)
 Set the specific visibility.
 
constexpr bool isVisibleInLayer (RenderLayers layerMask) const
 Check if the entity should be visible in the given layer mask.
 
constexpr bool isVisible () const
 Check if the entity is visible or not.
 
constexpr bool isPickable () const
 Check if the entity is pickable or not.
 
constexpr bool castShadows () const
 Get if the object should cast shadows.
 
constexpr bool disableCulling () const
 Get if the object should skip culling.
 
constexpr bool customMaterial () const
 
- 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.
 
- Public Attributes inherited from Cogs::Core::RenderComponent
struct Cogs::Core::RenderComponent::LodData lod
 
RenderLayers layer = RenderLayers::Default
 Layer mask used to determine visibility for a given camera viewport.
 
int32_t drawOrder = 0
 Draw order within a render bucke.
 
RenderFlags renderFlags = RenderFlags::Default
 Render flags used to control rendering behavior.
 
uint32_t objectId = NoObjectId
 Object identifier passed to rendering commands.
 
ComponentModel::ComponentHandle clipShapeComponent = ComponentModel::ComponentHandle::Empty()
 Handle to the currently active clip component, if any.
 

Detailed Description

Definition at line 59 of file SpriteRenderComponent.h.

Member Function Documentation

◆ registerType()

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

Definition at line 7 of file SpriteRenderComponent.cpp.


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