#include <HeightMapComponent.h>
Public Types | |
| enum struct | IsoLine : int { None , On , Top , Bottom } |
| enum struct | TextureDomain : int { Height , XY } |
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::shared_ptr< ComponentModel::Entity > | dataSet |
| Underlying 2D scalar dataset. | |
| std::shared_ptr< ComponentModel::Entity > | colorMap |
| Color map used to colorize values from the dataset. | |
| float | xIncrement |
| Grid line separation along x axis. | |
| float | yIncrement |
| Grid line separation along y axis. | |
| float | height |
| Height of maximum value. | |
| float | minValue |
| Explicitly set minimum value, set to NaN to use dataset's minimum value. | |
| float | maxValue |
| Explicitly set maximum value, set to NaN to use dataset's maximum value. | |
| bool | gridLines |
| Enable rendering of grid lines. | |
| glm::vec3 | gridLineOffset |
| Offset of grid lines relative to surface. | |
| IsoLine | isoLine |
| Enable iso-line rendering. | |
| float | isoLineOrigin |
| Value of zero'th iso-line, set to NaN to use current minimum value. | |
| float | isoLineDistance |
| Distance between consecutive iso-lines, set to NaN to use default value. | |
| TextureDomain | textureDomain |
| Specify how the texture coordinates of the points in the mesh are computed. | |
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
Holds a regular 2D grid of sampled scalar values.
Definition at line 17 of file HeightMapComponent.h.
Member Enumeration Documentation
◆ IsoLine
|
strong |
| Enumerator | |
|---|---|
| None | No iso-levels. |
| On | Iso-line on surface. |
| Top | Iso-line on top of bounding box. |
| Bottom | Iso-line on bottom of bounding box. |
Definition at line 20 of file HeightMapComponent.h.
◆ TextureDomain
|
strong |
| Enumerator | |
|---|---|
| XY | compute texture coordinates based on the height of the points Compute texture coordinates based on x and y values of the points |
Definition at line 28 of file HeightMapComponent.h.
Constructor & Destructor Documentation
◆ HeightMapComponent()
|
inline |
Definition at line 34 of file HeightMapComponent.h.
Member Function Documentation
◆ registerType()
|
static |
Definition at line 6 of file HeightMapComponent.cpp.
Member Data Documentation
◆ colorMap
| std::shared_ptr<ComponentModel::Entity> Cogs::Core::HeightMapComponent::colorMap |
Color map used to colorize values from the dataset.
Definition at line 51 of file HeightMapComponent.h.
◆ dataSet
| std::shared_ptr<ComponentModel::Entity> Cogs::Core::HeightMapComponent::dataSet |
Underlying 2D scalar dataset.
Definition at line 50 of file HeightMapComponent.h.
◆ gridLineOffset
| glm::vec3 Cogs::Core::HeightMapComponent::gridLineOffset |
Offset of grid lines relative to surface.
Definition at line 58 of file HeightMapComponent.h.
◆ gridLines
| bool Cogs::Core::HeightMapComponent::gridLines |
Enable rendering of grid lines.
Definition at line 57 of file HeightMapComponent.h.
◆ height
| float Cogs::Core::HeightMapComponent::height |
Height of maximum value.
Definition at line 54 of file HeightMapComponent.h.
◆ isoLine
| IsoLine Cogs::Core::HeightMapComponent::isoLine |
Enable iso-line rendering.
Definition at line 59 of file HeightMapComponent.h.
◆ isoLineDistance
| float Cogs::Core::HeightMapComponent::isoLineDistance |
Distance between consecutive iso-lines, set to NaN to use default value.
Definition at line 61 of file HeightMapComponent.h.
◆ isoLineOrigin
| float Cogs::Core::HeightMapComponent::isoLineOrigin |
Value of zero'th iso-line, set to NaN to use current minimum value.
Definition at line 60 of file HeightMapComponent.h.
◆ maxValue
| float Cogs::Core::HeightMapComponent::maxValue |
Explicitly set maximum value, set to NaN to use dataset's maximum value.
Definition at line 56 of file HeightMapComponent.h.
◆ minValue
| float Cogs::Core::HeightMapComponent::minValue |
Explicitly set minimum value, set to NaN to use dataset's minimum value.
Definition at line 55 of file HeightMapComponent.h.
◆ textureDomain
| TextureDomain Cogs::Core::HeightMapComponent::textureDomain |
Specify how the texture coordinates of the points in the mesh are computed.
Definition at line 62 of file HeightMapComponent.h.
◆ xIncrement
| float Cogs::Core::HeightMapComponent::xIncrement |
Grid line separation along x axis.
Definition at line 52 of file HeightMapComponent.h.
◆ yIncrement
| float Cogs::Core::HeightMapComponent::yIncrement |
Grid line separation along y axis.
Definition at line 53 of file HeightMapComponent.h.
The documentation for this struct was generated from the following files:
- Extensions/HeightMap/Source/HeightMapComponent.h
- Extensions/HeightMap/Source/HeightMapComponent.cpp
