Inheritance diagram for Cogs::Core::RiserFlexJointComponent:

Public Member Functions
void	initialize (Context *context)

void	update ()

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
bool	reverse = false
	If the shape should be reversed.

float	connectorRadius = 1.2f
	Length of the connectors.

float	connectorLength = 1.0f
	Radius of the connectors.

float	innerRadius = 0.8f
	Inner radius of the joint.

float	outerRadius = 1.0f
	Outer radius of the joint.

float	flexOuterRadius = 1.3f
	Outer radius of the flex bulge.

float	flexInnerRadius = 1.1f
	Inner radius of the flex bulge.

float	flexStart = 1.5f
	Offset of the start of the flex from the start depth.

float	flexLength = 1.0f
	Length of the flex section.

float	startDepth = 0.0f
	Start depth along trajectory.

float	endDepth = 100.0f
	End depth along 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 9 of file RiserFlexJointComponent.h.

Constructor & Destructor Documentation

◆ RiserFlexJointComponent()

Cogs::Core::RiserFlexJointComponent::RiserFlexJointComponent ( )

inline

Definition at line 12 of file RiserFlexJointComponent.h.

Member Function Documentation

◆ initialize()

void Cogs::Core::RiserFlexJointComponent::initialize ( Context * context )

Definition at line 45 of file RiserFlexJointComponent.cpp.

◆ registerType()

void Cogs::Core::RiserFlexJointComponent::registerType ( )

static

Definition at line 16 of file RiserFlexJointComponent.cpp.

◆ update()

void Cogs::Core::RiserFlexJointComponent::update ( )

Definition at line 49 of file RiserFlexJointComponent.cpp.

Member Data Documentation

◆ connectorLength

float Cogs::Core::RiserFlexJointComponent::connectorLength = 1.0f

Radius of the connectors.

Definition at line 20 of file RiserFlexJointComponent.h.

◆ connectorRadius

float Cogs::Core::RiserFlexJointComponent::connectorRadius = 1.2f

Length of the connectors.

Definition at line 19 of file RiserFlexJointComponent.h.

◆ endDepth

float Cogs::Core::RiserFlexJointComponent::endDepth = 100.0f

End depth along trajectory.

See TrajectoryComponent Field indexes, Measured Depth (MD)

Definition at line 32 of file RiserFlexJointComponent.h.

◆ flexInnerRadius

float Cogs::Core::RiserFlexJointComponent::flexInnerRadius = 1.1f

Inner radius of the flex bulge.

Definition at line 26 of file RiserFlexJointComponent.h.

◆ flexLength

float Cogs::Core::RiserFlexJointComponent::flexLength = 1.0f

Length of the flex section.

Definition at line 29 of file RiserFlexJointComponent.h.

◆ flexOuterRadius

float Cogs::Core::RiserFlexJointComponent::flexOuterRadius = 1.3f

Outer radius of the flex bulge.

Definition at line 25 of file RiserFlexJointComponent.h.

◆ flexStart

float Cogs::Core::RiserFlexJointComponent::flexStart = 1.5f

Offset of the start of the flex from the start depth.

Definition at line 28 of file RiserFlexJointComponent.h.

◆ innerRadius

float Cogs::Core::RiserFlexJointComponent::innerRadius = 0.8f

Inner radius of the joint.

Definition at line 22 of file RiserFlexJointComponent.h.

◆ outerRadius

float Cogs::Core::RiserFlexJointComponent::outerRadius = 1.0f

Outer radius of the joint.

Definition at line 23 of file RiserFlexJointComponent.h.

◆ reverse

bool Cogs::Core::RiserFlexJointComponent::reverse = false

If the shape should be reversed.

Definition at line 17 of file RiserFlexJointComponent.h.

◆ startDepth

float Cogs::Core::RiserFlexJointComponent::startDepth = 0.0f

Start depth along trajectory.