Contains a model reference to instance as children to the entity the ModelComponent belongs to. More...
#include <ModelComponent.h>
Static Public Member Functions | |
| 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. | |
Public Attributes | |
| ModelHandle | model = ModelHandle::NoHandle |
| Handle to a model resource that will be instanced onto the entity this ModelComponent belongs to. | |
| MaterialInstanceHandle | materialInstance = MaterialInstanceHandle::NoHandle |
| Explicit material handle. | |
| bool | inheritMaterial = false |
| If the model should inherit the material from the base entity. | |
| bool | shareMaterial = true |
| If the model should use shared model materials and not create it's own instances. | |
| bool | waitForSubresources = true |
| If the model should wait for all subresources (e.g. meshes) to be fully loaded before instantiating hierarchy. | |
| bool | setCoordinate = true |
| If model resource has a localOrigin property, forward this value to the TransformComponent's coordinate of the root that holds this entity. | |
Additional Inherited Members | |
| 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. | |
Detailed Description
Contains a model reference to instance as children to the entity the ModelComponent belongs to.
Definition at line 14 of file ModelComponent.h.
Member Function Documentation
◆ registerType()
|
static |
Register the type in the type system.
Definition at line 7 of file ModelComponent.cpp.
References inheritMaterial, materialInstance, model, setCoordinate, shareMaterial, and waitForSubresources.
Member Data Documentation
◆ inheritMaterial
| bool Cogs::Core::ModelComponent::inheritMaterial = false |
If the model should inherit the material from the base entity.
Definition at line 32 of file ModelComponent.h.
Referenced by Cogs::Core::OGC3DTilesSystem::addModelToScene(), and registerType().
◆ materialInstance
| MaterialInstanceHandle Cogs::Core::ModelComponent::materialInstance = MaterialInstanceHandle::NoHandle |
Explicit material handle.
Definition at line 29 of file ModelComponent.h.
Referenced by Cogs::Core::OGC3DTilesSystem::addModelToScene(), and registerType().
◆ model
| ModelHandle Cogs::Core::ModelComponent::model = ModelHandle::NoHandle |
Handle to a model resource that will be instanced onto the entity this ModelComponent belongs to.
- See also
- Model
- ModelSystem
Definition at line 26 of file ModelComponent.h.
Referenced by Cogs::Core::OGC3DTilesSystem::addModelToScene(), Cogs::Core::ExportCommand::apply(), Cogs::Core::ModelSystem::getLoadProgress(), and registerType().
◆ setCoordinate
| bool Cogs::Core::ModelComponent::setCoordinate = true |
If model resource has a localOrigin property, forward this value to the TransformComponent's coordinate of the root that holds this entity.
Definition at line 41 of file ModelComponent.h.
Referenced by registerType().
◆ shareMaterial
| bool Cogs::Core::ModelComponent::shareMaterial = true |
If the model should use shared model materials and not create it's own instances.
Definition at line 35 of file ModelComponent.h.
Referenced by registerType().
◆ waitForSubresources
| bool Cogs::Core::ModelComponent::waitForSubresources = true |
If the model should wait for all subresources (e.g. meshes) to be fully loaded before instantiating hierarchy.
Definition at line 38 of file ModelComponent.h.
Referenced by registerType().
The documentation for this struct was generated from the following files:
- Source/Components/Core/ModelComponent.h
- Source/Components/Core/ModelComponent.cpp
