#include <HighlightRegionComponent.h>
Inheritance diagram for Cogs::Core::HighlightRegionComponent:
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. | |
Public Attributes | |
| std::vector< glm::quat > | rotation |
| Instance rotations. | |
| std::vector< glm::vec3 > | position |
| Instance positions. | |
| std::vector< glm::vec3 > | scale |
| Instance scale factors. | |
| std::vector< glm::vec4 > | color |
| Instance colors, alpha gives effect intenisty. | |
| std::vector< uint32_t > | id |
| Instance ids. | |
| float | alpha = 1.f |
| Overall alpha multiplied with the per instance alpha to give effective alpha. | |
| float | depthSlopedFactor = 0.f |
| Pull highlight frontface slightly towards the camera based on surface slope. | |
| float | depthConstantBias = 0.f |
| Pull highlight frontface slightly towards the camera with a constant. | |
| bool | debugForceVisible = false |
| Debug option to force region to be visible regardles contents in the region, to help tracking down misplaced regions. | |
| bool | debugForceNoSplit = false |
| Disable use of cube splitting to handle near-plane clipping. | |
| bool | debugShowTriangles = false |
| Debug option to give triangles different colors. | |
| bool | debugDiscardBehindNearNotEye = false |
| Debug option to change plane which triggers region discard. | |
| 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. | |
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 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
Component for highlighting regions.
Definition at line 11 of file HighlightRegionComponent.h.
Member Function Documentation
◆ registerType()
|
static |
Definition at line 8 of file HighlightRegionComponent.cpp.
Member Data Documentation
◆ alpha
| float Cogs::Core::HighlightRegionComponent::alpha = 1.f |
Overall alpha multiplied with the per instance alpha to give effective alpha.
Definition at line 22 of file HighlightRegionComponent.h.
◆ color
| std::vector<glm::vec4> Cogs::Core::HighlightRegionComponent::color |
Instance colors, alpha gives effect intenisty.
Definition at line 19 of file HighlightRegionComponent.h.
◆ debugDiscardBehindNearNotEye
| bool Cogs::Core::HighlightRegionComponent::debugDiscardBehindNearNotEye = false |
Debug option to change plane which triggers region discard.
Definition at line 29 of file HighlightRegionComponent.h.
◆ debugForceNoSplit
| bool Cogs::Core::HighlightRegionComponent::debugForceNoSplit = false |
Disable use of cube splitting to handle near-plane clipping.
Definition at line 27 of file HighlightRegionComponent.h.
◆ debugForceVisible
| bool Cogs::Core::HighlightRegionComponent::debugForceVisible = false |
Debug option to force region to be visible regardles contents in the region, to help tracking down misplaced regions.
Definition at line 26 of file HighlightRegionComponent.h.
◆ debugShowTriangles
| bool Cogs::Core::HighlightRegionComponent::debugShowTriangles = false |
Debug option to give triangles different colors.
Definition at line 28 of file HighlightRegionComponent.h.
◆ depthConstantBias
| float Cogs::Core::HighlightRegionComponent::depthConstantBias = 0.f |
Pull highlight frontface slightly towards the camera with a constant.
Definition at line 24 of file HighlightRegionComponent.h.
◆ depthSlopedFactor
| float Cogs::Core::HighlightRegionComponent::depthSlopedFactor = 0.f |
Pull highlight frontface slightly towards the camera based on surface slope.
Definition at line 23 of file HighlightRegionComponent.h.
◆ id
| std::vector<uint32_t> Cogs::Core::HighlightRegionComponent::id |
Instance ids.
Definition at line 20 of file HighlightRegionComponent.h.
◆ position
| std::vector<glm::vec3> Cogs::Core::HighlightRegionComponent::position |
Instance positions.
Definition at line 17 of file HighlightRegionComponent.h.
◆ rotation
| std::vector<glm::quat> Cogs::Core::HighlightRegionComponent::rotation |
Instance rotations.
Definition at line 16 of file HighlightRegionComponent.h.
◆ scale
| std::vector<glm::vec3> Cogs::Core::HighlightRegionComponent::scale |
Instance scale factors.
Definition at line 18 of file HighlightRegionComponent.h.
The documentation for this class was generated from the following files:
- Extensions/HighlightRegion/Source/HighlightRegionComponent.h
- Extensions/HighlightRegion/Source/HighlightRegionComponent.cpp
