Cogs.Core
Public Types | Static Public Member Functions | Public Attributes | List of all members
Cogs::Core::TrajectoryCrossSectionsComponent Struct Reference
Inheritance diagram for Cogs::Core::TrajectoryCrossSectionsComponent:
Cogs::ComponentModel::Component

Public Types

enum struct  Parameterization : int { None , UnitSquare , CoordLengthOverCircumference }
 

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::Entitytrajectory
 
float startMeasuredDepth = 0.f
 Spine of the tubular shape.
 
float stopMeasuredDepth = 1.f
 Measured depth along trajectory where casing stops.
 
float radiusScale = 1.f
 Factor by which to scale the inner and outer radius.
 
int samples = 16
 Number of samples around the circumference.
 
float innerRadius = 0.99f
 The inner radius of the tubular shape, only used for Hollow shape.
 
float outerRadius = 1.f
 The outer radius of the tubular shape, used for all shapes.
 
Parameterization parameterization = Parameterization::None
 
LoftedCrossSectionsComponent::Shape shape = LoftedCrossSectionsComponent::Shape::Shell
 

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

Definition at line 11 of file TrajectoryCrossSectionsComponent.h.

Member Enumeration Documentation

◆ Parameterization

Enumerator
None 

No texture coordinates are generated.

UnitSquare 

Unit square mapped over shape.

CoordLengthOverCircumference 

U maps to [0,1) around circumference, V is coordlength divided by circumference.

Definition at line 13 of file TrajectoryCrossSectionsComponent.h.

Member Function Documentation

◆ registerType()

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

Definition at line 6 of file TrajectoryCrossSectionsComponent.cpp.

Member Data Documentation

◆ innerRadius

float Cogs::Core::TrajectoryCrossSectionsComponent::innerRadius = 0.99f

The inner radius of the tubular shape, only used for Hollow shape.

Definition at line 25 of file TrajectoryCrossSectionsComponent.h.

◆ outerRadius

float Cogs::Core::TrajectoryCrossSectionsComponent::outerRadius = 1.f

The outer radius of the tubular shape, used for all shapes.

Definition at line 26 of file TrajectoryCrossSectionsComponent.h.

Referenced by Cogs::Core::TrajectoryCrossSectionsSystem::update().

◆ parameterization

Parameterization Cogs::Core::TrajectoryCrossSectionsComponent::parameterization = Parameterization::None

Definition at line 27 of file TrajectoryCrossSectionsComponent.h.

◆ radiusScale

float Cogs::Core::TrajectoryCrossSectionsComponent::radiusScale = 1.f

Factor by which to scale the inner and outer radius.

Definition at line 23 of file TrajectoryCrossSectionsComponent.h.

Referenced by Cogs::Core::TrajectoryCrossSectionsSystem::update().

◆ samples

int Cogs::Core::TrajectoryCrossSectionsComponent::samples = 16

Number of samples around the circumference.

Definition at line 24 of file TrajectoryCrossSectionsComponent.h.

Referenced by Cogs::Core::TrajectoryCrossSectionsSystem::update().

◆ shape

LoftedCrossSectionsComponent::Shape Cogs::Core::TrajectoryCrossSectionsComponent::shape = LoftedCrossSectionsComponent::Shape::Shell

Definition at line 28 of file TrajectoryCrossSectionsComponent.h.

◆ startMeasuredDepth

float Cogs::Core::TrajectoryCrossSectionsComponent::startMeasuredDepth = 0.f

Spine of the tubular shape.

Measured depth along trajectory where casing starts.

Definition at line 21 of file TrajectoryCrossSectionsComponent.h.

Referenced by Cogs::Core::TrajectoryCrossSectionsSystem::update().

◆ stopMeasuredDepth

float Cogs::Core::TrajectoryCrossSectionsComponent::stopMeasuredDepth = 1.f

Measured depth along trajectory where casing stops.

Definition at line 22 of file TrajectoryCrossSectionsComponent.h.

Referenced by Cogs::Core::TrajectoryCrossSectionsSystem::update().

◆ trajectory

std::shared_ptr<ComponentModel::Entity> Cogs::Core::TrajectoryCrossSectionsComponent::trajectory

Definition at line 20 of file TrajectoryCrossSectionsComponent.h.


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