Inheritance diagram for Cogs::Core::BasicOceanComponent:
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 | |
| glm::vec4 | color = glm::vec4(0.f, 0.11f, 0.18f, 1.f) |
| Color of water. Alpha taken from transparency component. | |
| BasicOceanWaves | waves = BasicOceanWaves::Default |
| BasicOceanBeliefSystem | beliefSystem = BasicOceanBeliefSystem::FlatEarth |
| BasicOceanReflection | reflection = BasicOceanReflection::Planar |
| bool | pbr = false |
| float | seaLevel = 0.f |
| Vertical displacement of average sea height. | |
| float | transparency = 0.f |
| Transparency of water. | |
| float | reflectionBrightness = 1.f |
| Multiplicative factor reflection. | |
| int | fftTileResolutionLog2 = 7 |
| float | significantWaveHeight = 4.f |
| float | dominantWavePeriod = 25.f |
| float | windSpeed = 10.f |
| float | windDirection = 0.f |
| std::string | reflectionTexFormat |
| EntityPtr | reflectionCamera |
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
Definition at line 43 of file BasicOceanComponent.h.
Member Function Documentation
◆ registerType()
|
static |
Definition at line 6 of file BasicOceanComponent.cpp.
Member Data Documentation
◆ beliefSystem
| BasicOceanBeliefSystem Cogs::Core::BasicOceanComponent::beliefSystem = BasicOceanBeliefSystem::FlatEarth |
Definition at line 51 of file BasicOceanComponent.h.
◆ color
| glm::vec4 Cogs::Core::BasicOceanComponent::color = glm::vec4(0.f, 0.11f, 0.18f, 1.f) |
Color of water. Alpha taken from transparency component.
Definition at line 47 of file BasicOceanComponent.h.
Referenced by Cogs::Core::BasicOceanSystem::update().
◆ dominantWavePeriod
| float Cogs::Core::BasicOceanComponent::dominantWavePeriod = 25.f |
Definition at line 69 of file BasicOceanComponent.h.
◆ fftTileResolutionLog2
| int Cogs::Core::BasicOceanComponent::fftTileResolutionLog2 = 7 |
Definition at line 66 of file BasicOceanComponent.h.
◆ pbr
| bool Cogs::Core::BasicOceanComponent::pbr = false |
Definition at line 55 of file BasicOceanComponent.h.
◆ reflection
| BasicOceanReflection Cogs::Core::BasicOceanComponent::reflection = BasicOceanReflection::Planar |
Definition at line 53 of file BasicOceanComponent.h.
◆ reflectionBrightness
| float Cogs::Core::BasicOceanComponent::reflectionBrightness = 1.f |
Multiplicative factor reflection.
Definition at line 64 of file BasicOceanComponent.h.
Referenced by Cogs::Core::BasicOceanSystem::update().
◆ reflectionCamera
| EntityPtr Cogs::Core::BasicOceanComponent::reflectionCamera |
Definition at line 75 of file BasicOceanComponent.h.
◆ reflectionTexFormat
| std::string Cogs::Core::BasicOceanComponent::reflectionTexFormat |
Definition at line 73 of file BasicOceanComponent.h.
◆ seaLevel
| float Cogs::Core::BasicOceanComponent::seaLevel = 0.f |
Vertical displacement of average sea height.
Definition at line 58 of file BasicOceanComponent.h.
Referenced by Cogs::Core::BasicOceanSystem::update().
◆ significantWaveHeight
| float Cogs::Core::BasicOceanComponent::significantWaveHeight = 4.f |
Definition at line 68 of file BasicOceanComponent.h.
◆ transparency
| float Cogs::Core::BasicOceanComponent::transparency = 0.f |
Transparency of water.
Definition at line 61 of file BasicOceanComponent.h.
Referenced by Cogs::Core::BasicOceanSystem::update().
◆ waves
| BasicOceanWaves Cogs::Core::BasicOceanComponent::waves = BasicOceanWaves::Default |
Definition at line 49 of file BasicOceanComponent.h.
◆ windDirection
| float Cogs::Core::BasicOceanComponent::windDirection = 0.f |
Definition at line 71 of file BasicOceanComponent.h.
◆ windSpeed
| float Cogs::Core::BasicOceanComponent::windSpeed = 10.f |
Definition at line 70 of file BasicOceanComponent.h.
The documentation for this class was generated from the following files:
- Source/Components/Appearance/BasicOceanComponent.h
- Source/Components/Appearance/BasicOceanComponent.cpp
