Cogs.Core
Static Public Member Functions | Public Attributes | List of all members
Cogs::Core::TwinCadModelComponent Class Reference

#include <TwinCadModelComponent.h>

Inheritance diagram for Cogs::Core::TwinCadModelComponent:
Cogs::ComponentModel::Component

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

BufferView< uint8_t > attributeMap
 
std::string substance
 
glm::vec3 emissiveColor = glm::vec3(0.0, 0.0, 0.0)
 
glm::vec4 diffuseColor = glm::vec4(1.0, 1.0, 1.0, 1.0)
 
glm::vec3 specularColor = glm::vec3(0.3, 0.3, 0.3)
 
float specularPower = 80.f
 
float metallic = 1.f
 
float roughness = 0.f
 
glm::vec3 substanceParams = glm::vec3(0.0, 0.0, 0.0)
 
glm::vec4 parameters = glm::vec4(0.0, 0.0, 0.0, 0.0)
 
glm::vec4 clipping = glm::vec4(0.0, 0.0, 0.0, 0.0)
 
glm::vec3 minClipping = glm::vec3(0.0, 0.0, 0.0)
 
glm::vec3 maxClipping = glm::vec3(0.0, 0.0, 0.0)
 
bool hasAttributeData = false
 
TextureHandle surfaceVarianceTexture
 
bool allowClipping = false
 
int customEffect = 0
 
int selectionEffect = 0
 
bool surfaceVariance = false
 
int numSubstanceDefinitionMaps = 0
 
bool pbrLighting = false
 

Additional Inherited Members

- Public Member Functions inherited from Cogs::ComponentModel::Component
class EntitygetContainer () 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 ComponentgetComponent (const Reflection::Name &name) const
 
COGSFOUNDATION_API ComponentgetComponent (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::TypegetType () 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 that control Kognitwin's visuals.

Definition at line 11 of file TwinCadModelComponent.h.

Member Function Documentation

◆ registerType()

void Cogs::Core::TwinCadModelComponent::registerType ( )
static

Definition at line 7 of file TwinCadModelComponent.cpp.

Member Data Documentation

◆ allowClipping

bool Cogs::Core::TwinCadModelComponent::allowClipping = false

Definition at line 47 of file TwinCadModelComponent.h.

◆ attributeMap

BufferView<uint8_t> Cogs::Core::TwinCadModelComponent::attributeMap

Attribute map for embedded ids

Currently follows the twin texture layout:

  • R, G, B encode color for selected/highlighted
  • A encodes state:
    • bits 0..1 encode transparency, which is ignored
    • bits 2..7 encode state, where the states are: 0: default 1: selected 2: highlighted 3: hidden 4: selected and highlighted

Definition at line 27 of file TwinCadModelComponent.h.

◆ clipping

glm::vec4 Cogs::Core::TwinCadModelComponent::clipping = glm::vec4(0.0, 0.0, 0.0, 0.0)

Definition at line 40 of file TwinCadModelComponent.h.

◆ customEffect

int Cogs::Core::TwinCadModelComponent::customEffect = 0

Definition at line 48 of file TwinCadModelComponent.h.

◆ diffuseColor

glm::vec4 Cogs::Core::TwinCadModelComponent::diffuseColor = glm::vec4(1.0, 1.0, 1.0, 1.0)

Definition at line 33 of file TwinCadModelComponent.h.

◆ emissiveColor

glm::vec3 Cogs::Core::TwinCadModelComponent::emissiveColor = glm::vec3(0.0, 0.0, 0.0)

Definition at line 32 of file TwinCadModelComponent.h.

◆ hasAttributeData

bool Cogs::Core::TwinCadModelComponent::hasAttributeData = false

Definition at line 43 of file TwinCadModelComponent.h.

◆ maxClipping

glm::vec3 Cogs::Core::TwinCadModelComponent::maxClipping = glm::vec3(0.0, 0.0, 0.0)

Definition at line 42 of file TwinCadModelComponent.h.

◆ metallic

float Cogs::Core::TwinCadModelComponent::metallic = 1.f

Definition at line 36 of file TwinCadModelComponent.h.

◆ minClipping

glm::vec3 Cogs::Core::TwinCadModelComponent::minClipping = glm::vec3(0.0, 0.0, 0.0)

Definition at line 41 of file TwinCadModelComponent.h.

◆ numSubstanceDefinitionMaps

int Cogs::Core::TwinCadModelComponent::numSubstanceDefinitionMaps = 0

Definition at line 51 of file TwinCadModelComponent.h.

◆ parameters

glm::vec4 Cogs::Core::TwinCadModelComponent::parameters = glm::vec4(0.0, 0.0, 0.0, 0.0)

Definition at line 39 of file TwinCadModelComponent.h.

◆ pbrLighting

bool Cogs::Core::TwinCadModelComponent::pbrLighting = false

Definition at line 52 of file TwinCadModelComponent.h.

◆ roughness

float Cogs::Core::TwinCadModelComponent::roughness = 0.f

Definition at line 37 of file TwinCadModelComponent.h.

◆ selectionEffect

int Cogs::Core::TwinCadModelComponent::selectionEffect = 0

Definition at line 49 of file TwinCadModelComponent.h.

◆ specularColor

glm::vec3 Cogs::Core::TwinCadModelComponent::specularColor = glm::vec3(0.3, 0.3, 0.3)

Definition at line 34 of file TwinCadModelComponent.h.

◆ specularPower

float Cogs::Core::TwinCadModelComponent::specularPower = 80.f

Definition at line 35 of file TwinCadModelComponent.h.

◆ substance

std::string Cogs::Core::TwinCadModelComponent::substance

Definition at line 29 of file TwinCadModelComponent.h.

◆ substanceParams

glm::vec3 Cogs::Core::TwinCadModelComponent::substanceParams = glm::vec3(0.0, 0.0, 0.0)

Definition at line 38 of file TwinCadModelComponent.h.

◆ surfaceVariance

bool Cogs::Core::TwinCadModelComponent::surfaceVariance = false

Definition at line 50 of file TwinCadModelComponent.h.

◆ surfaceVarianceTexture

TextureHandle Cogs::Core::TwinCadModelComponent::surfaceVarianceTexture

Definition at line 44 of file TwinCadModelComponent.h.


The documentation for this class was generated from the following files: