 |
Plasma Engine
2.0
|
|
Plasma Engine
2.0
|
Applies a vertical rotation in local space (local Y axis) to the owner game object. More...
#include <HeadBoneComponent.h>
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. | |
| void | SetVerticalRotation (float fRadians) |
| Sets the vertical rotation to a fixed value. | |
| void | ChangeVerticalRotation (float fRadians) |
| Adds or subtracts from the current rotation. | |
 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 | |
| plAngle | m_MaxVerticalRotation = plAngle::MakeFromDegree(80) |
Protected Member Functions | |
| void | Update () |
| 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 | OnActivated () |
| This method is called when the component gets activated. | |
| virtual void | OnDeactivated () |
| This method is called when the component gets deactivated. | |
| 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 | |
| plAngle | m_NewVerticalRotation |
| plAngle | m_CurVerticalRotation |
| 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. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from plNoBase | |
| static const plRTTI * | GetStaticRTTI () |
Applies a vertical rotation in local space (local Y axis) to the owner game object.
This component is meant to be used to apply a vertical rotation to a camera. For first-person camera movement, typically the horizontal rotation is already taken care of through the rotation of a character controller. To additionally allow a limited vertical rotation, this component is introduced. It is assumed that a local rotation of zero represents the "forward" camera direction and the camera is allowed to rotate both up and down by a certain number of degrees, for example 80 degrees. This component takes care to apply that amount of rotation and not more.
Call SetVerticalRotation() or ChangeVerticalRotation() to set or add some rotation.
| void plHeadBoneComponent::ChangeVerticalRotation | ( | float | fRadians | ) |
Adds or subtracts from the current rotation.
The final rotation will be clamped to the maximum allowed value.
|
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.
|
overridevirtual |
Override this to save the current state of the component to the given stream.
Reimplemented from plComponent.
| void plHeadBoneComponent::SetVerticalRotation | ( | float | fRadians | ) |
Sets the vertical rotation to a fixed value.
The final rotation will be clamped to the maximum allowed value.
1.11.0