Contains a handle to a Mesh resource to use when rendering using the MeshRenderComponent. More...
#include <MeshComponent.h>
Public Member Functions | |
| COGSCORE_DLL_API Mesh * | getMesh (class Context *context) |
| Utility for getting a pointer to the Mesh instance held by the component. | |
 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 () |
| 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 | |
| MeshHandle | meshHandle = MeshHandle::NoHandle |
| Handle to a Mesh resource to use when rendering. | |
Detailed Description
Contains a handle to a Mesh resource to use when rendering using the MeshRenderComponent.
Definition at line 14 of file MeshComponent.h.
Member Function Documentation
◆ getMesh()
| Cogs::Core::Mesh * Cogs::Core::MeshComponent::getMesh | ( | class Context * | context | ) |
Utility for getting a pointer to the Mesh instance held by the component.
If no mesh is currently held, a new mesh resource is allocated and the handle to it stored in the meshHandle.
- Parameters
-
context Pointer to the current context used to access the MeshManager.
- Returns
- A pointer to the Mesh held by the component. Will always return a valid pointer.
Definition at line 19 of file MeshComponent.cpp.
References Cogs::setChanged().
◆ registerType()
|
static |
Register the type in the type system.
Definition at line 10 of file MeshComponent.cpp.
References meshHandle.
Member Data Documentation
◆ meshHandle
| MeshHandle Cogs::Core::MeshComponent::meshHandle = MeshHandle::NoHandle |
Handle to a Mesh resource to use when rendering.
The mesh handle is an owning reference to the mesh resource, ensuring that if a valid mesh handle is set, the mesh resource will not be freed until this component is destructed, or the mesh handle set to another handle.
If the handle is not valid, no mesh will be passed when rendering a MeshRenderComponent attached to the same entity, and no geometry will appear on screen.
Definition at line 29 of file MeshComponent.h.
Referenced by Cogs::Core::EchoSounder::UniformGridSystem::preUpdate(), registerType(), Cogs::Core::MarkerPointSetSystem::update(), Cogs::Core::DepthAxisSystem::update(), Cogs::Core::ExtrusionSystem::update(), Cogs::Core::LoftedCrossSectionsSystem::update(), Cogs::Core::CurtainView::CurtainViewSystem::update(), Cogs::Core::EchoSounder::PingIsoSystem::update(), Cogs::Core::Volumetric::PointVisualizationSystem::update(), Cogs::Core::InstancedMeshRenderSystem::update(), Cogs::Core::InstancedModelSystem::update(), Cogs::Core::RenderSystem::update(), Cogs::Core::SubMeshRenderSystem::update(), Cogs::Core::AdaptivePlanarGridSystem::update(), and Cogs::Core::ShapeSystem::update().
The documentation for this class was generated from the following files:
- Source/Components/Core/MeshComponent.h
- Source/Components/Core/MeshComponent.cpp
