Renders a square billboard oriented towards the screen, positioned by the transform given by the TransformComponent. More...
#include <BillboardComponent.h>
Inheritance diagram for Cogs::Core::BillboardComponent:
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 | |
| glm::vec2 | imageSize = glm::vec2(0, 0) |
| Size of the billboard in pixels. | |
| bool | alwaysOnTop = false |
| Render billboard on top of normal geometry. | |
| bool | flipX = false |
| Flip the billboard horizontally. | |
| bool | flipY = false |
| Flip the billboard vertically. | |
| bool | padding = false |
| Padding. | |
| BlendMode | blendMode = BlendMode::Blend |
| Blend mode. | |
| VerticalAlignment | verticalAlignment = VerticalAlignment::Center |
| Vertical alignment of the billboard. | |
| HorizontalAlignment | horizontalAlignment = HorizontalAlignment::Center |
| Horizontal alignment of the billboard. | |
| TextureHandle | image = TextureHandle::NoHandle |
| Image to show. | |
| glm::vec4 | color = glm::vec4(1, 1, 1, 1) |
| Color tint of the billboard. | |
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
Renders a square billboard oriented towards the screen, positioned by the transform given by the TransformComponent.
The billboard is rendered with constant size, no matter the distance from the camera.
Definition at line 20 of file BillboardComponent.h.
Member Function Documentation
◆ registerType()
|
static |
Register the type in the type system.
Definition at line 7 of file BillboardComponent.cpp.
References alwaysOnTop, blendMode, color, flipX, flipY, horizontalAlignment, image, imageSize, and verticalAlignment.
Member Data Documentation
◆ alwaysOnTop
| bool Cogs::Core::BillboardComponent::alwaysOnTop = false |
Render billboard on top of normal geometry.
Definition at line 30 of file BillboardComponent.h.
Referenced by registerType().
◆ blendMode
| BlendMode Cogs::Core::BillboardComponent::blendMode = BlendMode::Blend |
◆ color
| glm::vec4 Cogs::Core::BillboardComponent::color = glm::vec4(1, 1, 1, 1) |
Color tint of the billboard.
Definition at line 54 of file BillboardComponent.h.
Referenced by registerType().
◆ flipX
| bool Cogs::Core::BillboardComponent::flipX = false |
Flip the billboard horizontally.
Definition at line 33 of file BillboardComponent.h.
Referenced by registerType().
◆ flipY
| bool Cogs::Core::BillboardComponent::flipY = false |
Flip the billboard vertically.
Definition at line 36 of file BillboardComponent.h.
Referenced by registerType().
◆ horizontalAlignment
| HorizontalAlignment Cogs::Core::BillboardComponent::horizontalAlignment = HorizontalAlignment::Center |
Horizontal alignment of the billboard.
Definition at line 48 of file BillboardComponent.h.
Referenced by registerType().
◆ image
| TextureHandle Cogs::Core::BillboardComponent::image = TextureHandle::NoHandle |
◆ imageSize
| glm::vec2 Cogs::Core::BillboardComponent::imageSize = glm::vec2(0, 0) |
Size of the billboard in pixels.
Definition at line 27 of file BillboardComponent.h.
Referenced by registerType().
◆ padding
| bool Cogs::Core::BillboardComponent::padding = false |
Padding.
Definition at line 39 of file BillboardComponent.h.
◆ verticalAlignment
| VerticalAlignment Cogs::Core::BillboardComponent::verticalAlignment = VerticalAlignment::Center |
Vertical alignment of the billboard.
Definition at line 45 of file BillboardComponent.h.
Referenced by registerType().
The documentation for this class was generated from the following files:
- Source/Components/Core/BillboardComponent.h
- Source/Components/Core/BillboardComponent.cpp
