Simulates the behavior of a rope/cable without physical interaction with the world. More...

#include <FakeRopeComponent.h>

Inheritance diagram for plFakeRopeComponent:

[legend]

Public Member Functions
virtual void	SerializeComponent (plWorldWriter &inout_stream) const override
	Override this to save the current state of the component to the given stream.

virtual void	DeserializeComponent (plWorldReader &inout_stream) override
	Override this to load the current state of the component from the given stream.

virtual void	OnActivated () override
	This method is called when the component gets activated.

virtual void	OnDeactivated () override
	This method is called when the component gets deactivated.

void	SetAnchor1Reference (const char *szReference)

void	SetAnchor2Reference (const char *szReference)

void	SetAnchor1 (plGameObjectHandle hActor)
	The first game object to attach to.

void	SetAnchor2 (plGameObjectHandle hActor)
	The second game object to attach to.

void	SetSlack (float fVal)
	How much the rope should sag. A value of 0 means it should be absolutely straight. In practice there is always slack, due to imprecision in the simulation.

float	GetSlack () const

void	SetAttachToAnchor1 (bool bVal)
	If true, the rope will be fixed to the first anchor, otherwise it will start there but then fall down.

void	SetAttachToAnchor2 (bool bVal)
	If true, the rope will be fixed to the second anchor, otherwise it will start there but then fall down.

bool	GetAttachToAnchor1 () const

bool	GetAttachToAnchor2 () const

Public Member Functions inherited from plComponent
void	SetActiveFlag (bool bEnabled)
	Sets the active flag of the component, which affects its active state.

bool	GetActiveFlag () const
	Checks whether the 'active flag' is set on this component. Note that this does not mean that the component is also 'active'.

bool	IsActive () const
	Checks whether this component is in an active state.

bool	IsActiveAndInitialized () const
	Returns whether this component is active and initialized.

bool	IsActiveAndSimulating () const
	Whether the component is currently active and simulation has been started as well.

plComponentManagerBase *	GetOwningManager ()
	Returns the corresponding manager for this component.

const plComponentManagerBase *	GetOwningManager () const
	Returns the corresponding manager for this component.

plGameObject *	GetOwner ()
	Returns the owner game object if the component is attached to one or nullptr.

const plGameObject *	GetOwner () const
	Returns the owner game object if the component is attached to one or nullptr.

plWorld *	GetWorld ()
	Returns the corresponding world for this component.

const plWorld *	GetWorld () const
	Returns the corresponding world for this component.

plComponentHandle	GetHandle () const
	Returns a handle to this component.

plUInt32	GetUniqueID () const
	Returns the unique id for this component.

void	SetUniqueID (plUInt32 uiUniqueID)
	Sets the unique id for this component.

void	EnsureInitialized ()
	Ensures that the component is initialized. Must only be called from another component's Initialize callback.

void	EnsureSimulationStarted ()
	Ensures that the OnSimulationStarted method has been called. Must only be called from another component's OnSimulationStarted callback.

PL_ALWAYS_INLINE bool	SendMessage (plMessage &ref_msg)
	Sends a message to this component.

PL_ALWAYS_INLINE bool	SendMessage (plMessage &ref_msg) const

void	PostMessage (const plMessage &msg, plTime delay=plTime::MakeZero(), plObjectMsgQueueType::Enum queueType=plObjectMsgQueueType::NextFrame) const
	Queues the message for the given phase. The message is processed after the given delay in the corresponding phase.

virtual bool	HandlesMessage (const plMessage &msg) const
	Returns whether the given Message is handled by this component.

void	SetUserFlag (plUInt8 uiFlagIndex, bool bSet)
	Be careful to check which flags may already be in use by base classes.

bool	GetUserFlag (plUInt8 uiFlagIndex) const
	Retrieves a custom flag. Index must be between 0 and 7.

void	SetCreatedByPrefab ()
	Adds plObjectFlags::CreatedByPrefab to the component. See the flag for details.

bool	WasCreatedByPrefab () const
	Checks whether the plObjectFlags::CreatedByPrefab flag is set on this component.

Public Member Functions inherited from plReflectedClass
virtual const plRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const plRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T >
PL_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Public Attributes
plUInt16	m_uiPieces = 16
	Of how many pieces the rope is made up.

float	m_fDamping = 0.5f
	How quickly a swinging rope comes to a stop.

Additional Inherited Members
Static Public Member Functions inherited from plNoBase
static const plRTTI *	GetStaticRTTI ()

Protected Member Functions inherited from plComponent
	plComponent ()
	Keep the constructor private or protected in derived classes, so it cannot be called manually.

bool	IsDynamic () const
	Returns whether this component is dynamic and thus can only be attached to dynamic game objects.

virtual plWorldModuleTypeId	GetTypeId () const =0

virtual plComponentMode::Enum	GetMode () const =0

virtual void	Initialize ()
	Can be overridden for basic initialization that depends on a valid hierarchy and position.

virtual void	Deinitialize ()
	This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work.

virtual void	OnSimulationStarted ()
	This method is called once for active components, at the start of the next world update, but only when the world is simulated.

void	EnableUnhandledMessageHandler (bool enable)
	By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message.

virtual bool	OnUnhandledMessage (plMessage &msg, bool bWasPostedMsg)
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

virtual bool	OnUnhandledMessage (plMessage &msg, bool bWasPostedMsg) const
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

bool	IsInitialized () const

bool	IsInitializing () const

bool	IsSimulationStarted () const

Protected Attributes inherited from plComponent
const plRTTI *	m_pMessageDispatchType = nullptr
	Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary.

Detailed Description

Simulates the behavior of a rope/cable without physical interaction with the world.

This component is mainly used for decorative purposes to add things like power lines, cables and ropes that hang in a level and should swing in the wind. This component only simulates simple rope physics, but doesn't take the surrounding geometry into account. Thus ropes will swing through other geometry, and the only way to prevent that, is to place the rope such, that it usually doesn't come close to other objects.

The fake rope simulation is more lightweight than proper physical simulation and also stops simulating when it isn't visible.

Prefer to use this over e.g. the plJoltRopeComponent, when the physical interaction isn't needed.

Member Function Documentation

◆ DeserializeComponent()

void plFakeRopeComponent::DeserializeComponent ( plWorldReader & inout_stream )

overridevirtual

Override this to load the current state of the component from the given stream.

The active state will be automatically serialized. The 'initialized' state is not serialized, all components will be initialized after creation, even if they were already in an initialized state when they were serialized.

Reimplemented from plComponent.

◆ OnActivated()

void plFakeRopeComponent::OnActivated ( )

overridevirtual

This method is called when the component gets activated.

By default a component is active, but it can be created in an inactive state. In such a case OnActivated() is only called once a component is activated. If a component gets switched between active and inactive at runtime, OnActivated() and OnDeactivated() are called accordingly. In contrast Initialize() and Deinitialize() are only ever called once.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from plComponent.

◆ OnDeactivated()

void plFakeRopeComponent::OnDeactivated ( )

overridevirtual

This method is called when the component gets deactivated.

Upon destruction, a component that is active first gets deactivated. Therefore OnDeactivated() should be used for typical game code cleanup.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from plComponent.

◆ SerializeComponent()

void plFakeRopeComponent::SerializeComponent ( plWorldWriter & inout_stream ) const

overridevirtual

Override this to save the current state of the component to the given stream.

Reimplemented from plComponent.

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

Code/EnginePlugins/GameComponentsPlugin/Physics/FakeRopeComponent.h
Code/EnginePlugins/GameComponentsPlugin/Physics/Implementation/FakeRopeComponent.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeserializeComponent()

◆ OnActivated()

◆ OnDeactivated()

◆ SerializeComponent()