Inheritance diagram for Cogs::Core::RiserTensionerComponent:
Public Member Functions | |
| void | initialize (Context *context) |
| void | update () |
| void | updateChildren () |
 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. | |
Static Public Member Functions | |
| static void | registerType () |
| Static Public Member Functions inherited from Cogs::Core::DynamicComponent | |
| static COGSCORE_DLL_API void | registerType () |
| Register the type in the type system. | |
| template<typename T > | |
| static Reflection::Type & | registerDerivedType () |
| Convenience method for registering the type of a derived component. | |
| 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::vec3 | topOffset |
| Offset of top from trajectory position. | |
| glm::vec3 | bottomOffset |
| Offset of bottom from trajectory position. | |
| float | cylinderLength = 0.0f |
| Length of the entire outer cylinder. | |
| float | cylinderRadius = 0.0f |
| Radius of the main part of the outer cylinder. | |
| float | cylinderInnerRadius = 0.0f |
| Inner radius of the cylinder. | |
| float | cylinderBaseRadius = 0.0f |
| Radius of the cylinder base. | |
| float | cylinderBaseLength = 0.0f |
| Length of the cylinder base part (measured from the start of the cylinder). | |
| float | cylinderHeadRadius = 0.0f |
| Radius of the cylinder head. | |
| float | cylinderHeadLength = 0.0f |
| Length of the cylinder head part (measured from the end of the cylinder). | |
| float | rodLength = 0.0f |
| Length of the rod. | |
| float | rodRadius = 0.0f |
| Radius of the rod. | |
| EntityPtr | rodMaterial |
| Rod material. | |
| float | startDepth = 0.0f |
| Start depth along trajectory. | |
| float | endDepth = 100.0f |
| End depth along trajectory. | |
| EntityPtr | innerShape |
| EntityPtr | outerShape |
| EntityPtr | trajectory |
| Public Attributes inherited from Cogs::Core::DynamicComponent | |
| void * | messageCallback = nullptr |
| void * | userData = nullptr |
| size_t | dynamicTypeInfoIndex = static_cast<size_t>(-1) |
Detailed Description
Definition at line 13 of file RiserTensionerComponent.h.
Constructor & Destructor Documentation
◆ RiserTensionerComponent()
|
inline |
Definition at line 16 of file RiserTensionerComponent.h.
Member Function Documentation
◆ initialize()
| void Cogs::Core::RiserTensionerComponent::initialize | ( | Context * | context | ) |
Definition at line 52 of file RiserTensionerComponent.cpp.
◆ registerType()
|
static |
Definition at line 21 of file RiserTensionerComponent.cpp.
◆ update()
| void Cogs::Core::RiserTensionerComponent::update | ( | ) |
Definition at line 62 of file RiserTensionerComponent.cpp.
◆ updateChildren()
| void Cogs::Core::RiserTensionerComponent::updateChildren | ( | ) |
Definition at line 187 of file RiserTensionerComponent.cpp.
Member Data Documentation
◆ bottomOffset
| glm::vec3 Cogs::Core::RiserTensionerComponent::bottomOffset |
Offset of bottom from trajectory position.
Definition at line 22 of file RiserTensionerComponent.h.
◆ cylinderBaseLength
| float Cogs::Core::RiserTensionerComponent::cylinderBaseLength = 0.0f |
Length of the cylinder base part (measured from the start of the cylinder).
Definition at line 28 of file RiserTensionerComponent.h.
◆ cylinderBaseRadius
| float Cogs::Core::RiserTensionerComponent::cylinderBaseRadius = 0.0f |
Radius of the cylinder base.
Definition at line 27 of file RiserTensionerComponent.h.
◆ cylinderHeadLength
| float Cogs::Core::RiserTensionerComponent::cylinderHeadLength = 0.0f |
Length of the cylinder head part (measured from the end of the cylinder).
Definition at line 30 of file RiserTensionerComponent.h.
◆ cylinderHeadRadius
| float Cogs::Core::RiserTensionerComponent::cylinderHeadRadius = 0.0f |
Radius of the cylinder head.
Definition at line 29 of file RiserTensionerComponent.h.
◆ cylinderInnerRadius
| float Cogs::Core::RiserTensionerComponent::cylinderInnerRadius = 0.0f |
Inner radius of the cylinder.
Definition at line 26 of file RiserTensionerComponent.h.
◆ cylinderLength
| float Cogs::Core::RiserTensionerComponent::cylinderLength = 0.0f |
Length of the entire outer cylinder.
Definition at line 24 of file RiserTensionerComponent.h.
◆ cylinderRadius
| float Cogs::Core::RiserTensionerComponent::cylinderRadius = 0.0f |
Radius of the main part of the outer cylinder.
Definition at line 25 of file RiserTensionerComponent.h.
◆ endDepth
| float Cogs::Core::RiserTensionerComponent::endDepth = 100.0f |
End depth along trajectory.
See TrajectoryComponent Field indexes, Measured Depth (MD)
Definition at line 38 of file RiserTensionerComponent.h.
◆ innerShape
| EntityPtr Cogs::Core::RiserTensionerComponent::innerShape |
Definition at line 46 of file RiserTensionerComponent.h.
◆ outerShape
| EntityPtr Cogs::Core::RiserTensionerComponent::outerShape |
Definition at line 47 of file RiserTensionerComponent.h.
◆ rodLength
| float Cogs::Core::RiserTensionerComponent::rodLength = 0.0f |
Length of the rod.
Definition at line 32 of file RiserTensionerComponent.h.
◆ rodMaterial
| EntityPtr Cogs::Core::RiserTensionerComponent::rodMaterial |
Rod material.
Definition at line 35 of file RiserTensionerComponent.h.
◆ rodRadius
| float Cogs::Core::RiserTensionerComponent::rodRadius = 0.0f |
Radius of the rod.
Definition at line 33 of file RiserTensionerComponent.h.
◆ startDepth
| float Cogs::Core::RiserTensionerComponent::startDepth = 0.0f |
Start depth along trajectory.
See TrajectoryComponent Field indexes, Measured Depth (MD)
Definition at line 37 of file RiserTensionerComponent.h.
◆ topOffset
| glm::vec3 Cogs::Core::RiserTensionerComponent::topOffset |
Offset of top from trajectory position.
Definition at line 21 of file RiserTensionerComponent.h.
◆ trajectory
| EntityPtr Cogs::Core::RiserTensionerComponent::trajectory |
Definition at line 49 of file RiserTensionerComponent.h.
The documentation for this class was generated from the following files:
- Extensions/Drilling/Source/RiserTensionerComponent.h
- Extensions/Drilling/Source/RiserTensionerComponent.cpp
