Inheritance diagram for Cogs::Core::TensionRingComponent:
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 | |
| float | extensionRadius = 1.3f |
| Outermost extended radius of the ring. | |
| float | splitDistance = 0.0f |
| The distance between the two halves of the ring if it is split in two. | |
| float | splitAngle = 0.0f |
| Specify at which angle in radians the ring should be split in two. | |
| float | innerRadius = 0.8f |
| Inner radius of the tension ring. | |
| float | outerRadius = 1.0f |
| Outer radius of the tension ring. | |
| float | startDepth = 0.0f |
| Start depth along trajectory. | |
| float | endDepth = 100.0f |
| End depth along trajectory. | |
| float | startAngle = 0.0f |
| EntityPtr | shape1 |
| EntityPtr | shape2 |
| EntityPtr | trajectory1 |
| EntityPtr | trajectory2 |
| 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 11 of file TensionRingComponent.h.
Constructor & Destructor Documentation
◆ TensionRingComponent()
|
inline |
Definition at line 14 of file TensionRingComponent.h.
Member Function Documentation
◆ initialize()
| void Cogs::Core::TensionRingComponent::initialize | ( | Context * | context | ) |
Definition at line 46 of file TensionRingComponent.cpp.
◆ registerType()
|
static |
Definition at line 22 of file TensionRingComponent.cpp.
◆ update()
| void Cogs::Core::TensionRingComponent::update | ( | ) |
Definition at line 55 of file TensionRingComponent.cpp.
◆ updateChildren()
| void Cogs::Core::TensionRingComponent::updateChildren | ( | ) |
Definition at line 187 of file TensionRingComponent.cpp.
Member Data Documentation
◆ endDepth
| float Cogs::Core::TensionRingComponent::endDepth = 100.0f |
End depth along trajectory.
See TrajectoryComponent Field indexes, Measured Depth (MD)
Definition at line 27 of file TensionRingComponent.h.
◆ extensionRadius
| float Cogs::Core::TensionRingComponent::extensionRadius = 1.3f |
Outermost extended radius of the ring.
Definition at line 19 of file TensionRingComponent.h.
◆ innerRadius
| float Cogs::Core::TensionRingComponent::innerRadius = 0.8f |
Inner radius of the tension ring.
Definition at line 23 of file TensionRingComponent.h.
◆ outerRadius
| float Cogs::Core::TensionRingComponent::outerRadius = 1.0f |
Outer radius of the tension ring.
Definition at line 24 of file TensionRingComponent.h.
◆ shape1
| EntityPtr Cogs::Core::TensionRingComponent::shape1 |
Definition at line 37 of file TensionRingComponent.h.
◆ shape2
| EntityPtr Cogs::Core::TensionRingComponent::shape2 |
Definition at line 38 of file TensionRingComponent.h.
◆ splitAngle
| float Cogs::Core::TensionRingComponent::splitAngle = 0.0f |
Specify at which angle in radians the ring should be split in two.
Definition at line 21 of file TensionRingComponent.h.
◆ splitDistance
| float Cogs::Core::TensionRingComponent::splitDistance = 0.0f |
The distance between the two halves of the ring if it is split in two.
Definition at line 20 of file TensionRingComponent.h.
◆ startAngle
| float Cogs::Core::TensionRingComponent::startAngle = 0.0f |
Definition at line 29 of file TensionRingComponent.h.
◆ startDepth
| float Cogs::Core::TensionRingComponent::startDepth = 0.0f |
Start depth along trajectory.
See TrajectoryComponent Field indexes, Measured Depth (MD)
Definition at line 26 of file TensionRingComponent.h.
◆ trajectory1
| EntityPtr Cogs::Core::TensionRingComponent::trajectory1 |
Definition at line 40 of file TensionRingComponent.h.
◆ trajectory2
| EntityPtr Cogs::Core::TensionRingComponent::trajectory2 |
Definition at line 41 of file TensionRingComponent.h.
The documentation for this class was generated from the following files:
- Extensions/Drilling/Source/TensionRingComponent.h
- Extensions/Drilling/Source/TensionRingComponent.cpp
