XII Release 0.1.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
xiiSensorSphereComponent Class Reference
Inheritance diagram for xiiSensorSphereComponent:
[legend]

Public Member Functions

virtual void SerializeComponent (xiiWorldWriter &inout_stream) const override
 Override this to save the current state of the component to the given stream.
 
virtual void DeserializeComponent (xiiWorldReader &inout_stream) override
 Override this to load the current state of the component from the given stream.
 
virtual void GetObjectsInSensorVolume (xiiDynamicArray< xiiGameObject * > &out_objects) const override
 
virtual void DebugDrawSensorShape () const override
 
- Public Member Functions inherited from xiiSensorComponent
void SetSpatialCategory (const char *szCategory)
 
const char * GetSpatialCategory () const
 
void SetUpdateRate (const xiiEnum< xiiUpdateRate > &updateRate)
 
const xiiEnum< xiiUpdateRate > & GetUpdateRate () const
 
void SetShowDebugInfo (bool bShow)
 
bool GetShowDebugInfo () const
 
void SetColor (xiiColorGammaUB color)
 
xiiColorGammaUB GetColor () const
 
xiiArrayPtr< const xiiGameObjectHandle > GetLastDetectedObjects () const
 Returns the list of objects that this sensor has detected during its last update.
 
bool RunSensorCheck (xiiPhysicsWorldModuleInterface *pPhysicsWorldModule, xiiDynamicArray< xiiGameObject * > &out_objectsInSensorVolume, xiiDynamicArray< xiiGameObjectHandle > &ref_detectedObjects, bool bPostChangeMsg) const
 Updates the sensor state right now.
 
- Public Member Functions inherited from xiiComponent
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.
 
xiiComponentManagerBase * GetOwningManager ()
 Returns the corresponding manager for this component.
 
const xiiComponentManagerBase * GetOwningManager () const
 Returns the corresponding manager for this component.
 
xiiGameObject * GetOwner ()
 Returns the owner game object if the component is attached to one or nullptr.
 
const xiiGameObject * GetOwner () const
 Returns the owner game object if the component is attached to one or nullptr.
 
xiiWorld * GetWorld ()
 Returns the corresponding world for this component.
 
const xiiWorld * GetWorld () const
 Returns the corresponding world for this component.
 
xiiComponentHandle GetHandle () const
 Returns a handle to this component.
 
xiiUInt32 GetUniqueID () const
 Returns the unique id for this component.
 
void SetUniqueID (xiiUInt32 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.
 
XII_ALWAYS_INLINE bool SendMessage (xiiMessage &ref_msg)
 Sends a message to this component.
 
XII_ALWAYS_INLINE bool SendMessage (xiiMessage &ref_msg) const
 
void PostMessage (const xiiMessage &msg, xiiTime delay=xiiTime::MakeZero(), xiiObjectMsgQueueType::Enum queueType=xiiObjectMsgQueueType::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 xiiMessage &msg) const
 Returns whether the given Message is handled by this component.
 
void SetUserFlag (xiiUInt8 uiFlagIndex, bool bSet)
 Be careful to check which flags may already be in use by base classes.
 
bool GetUserFlag (xiiUInt8 uiFlagIndex) const
 Retrieves a custom flag. Index must be between 0 and 7.
 
void SetCreatedByPrefab ()
 Adds xiiObjectFlags::CreatedByPrefab to the component. See the flag for details.
 
bool WasCreatedByPrefab () const
 Checks whether the xiiObjectFlags::CreatedByPrefab flag is set on this component.
 
- Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI * GetDynamicRTTI () const
 
bool IsInstanceOf (const xiiRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T>
XII_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Public Attributes

float m_fRadius = 10.0f
 
- Public Attributes inherited from xiiSensorComponent
bool m_bTestVisibility = true
 
xiiUInt8 m_uiCollisionLayer = 0
 

Additional Inherited Members

- Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI * GetStaticRTTI ()
 
- Protected Member Functions inherited from xiiSensorComponent
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 UpdateSpatialCategory ()
 
void UpdateScheduling ()
 
void UpdateDebugInfo ()
 
- Protected Member Functions inherited from xiiComponent
 xiiComponent ()
 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 xiiWorldModuleTypeId GetTypeId () const =0
 
virtual xiiComponentMode::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 (xiiMessage &msg, bool bWasPostedMsg)
 When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.
 
virtual bool OnUnhandledMessage (xiiMessage &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 xiiSensorComponent
xiiEnum< xiiUpdateRate > m_UpdateRate
 
bool m_bShowDebugInfo = false
 
xiiColorGammaUB m_Color = xiiColorScheme::LightUI(xiiColorScheme::Orange)
 
xiiHashedString m_sSpatialCategory
 
xiiSpatialData::Category m_SpatialCategory = xiiInvalidSpatialDataCategory
 
xiiDynamicArray< xiiGameObjectHandle > m_LastDetectedObjects
 
- Protected Attributes inherited from xiiComponent
const xiiRTTI * m_pMessageDispatchType = nullptr
 Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary.
 

Member Function Documentation

◆ DebugDrawSensorShape()

void xiiSensorSphereComponent::DebugDrawSensorShape ( ) const
overridevirtual

Implements xiiSensorComponent.

◆ DeserializeComponent()

void xiiSensorSphereComponent::DeserializeComponent ( xiiWorldReader & ref_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 xiiSensorComponent.

◆ GetObjectsInSensorVolume()

void xiiSensorSphereComponent::GetObjectsInSensorVolume ( xiiDynamicArray< xiiGameObject * > & out_objects) const
overridevirtual

Implements xiiSensorComponent.

◆ SerializeComponent()

void xiiSensorSphereComponent::SerializeComponent ( xiiWorldWriter & ref_stream) const
overridevirtual

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

Reimplemented from xiiSensorComponent.

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