XII Release 0.1.0
Loading...
Searching...
No Matches
xiiSurfaceResource Class Reference
Inheritance diagram for xiiSurfaceResource:
[legend]

Public Member Functions

const xiiSurfaceResourceDescriptor & GetDescriptor () const
bool InteractWithSurface (xiiWorld *pWorld, xiiGameObjectHandle hObject, const xiiVec3 &vPosition, const xiiVec3 &vSurfaceNormal, const xiiVec3 &vIncomingDirection, const xiiTempHashedString &sInteraction, const xiiUInt16 *pOverrideTeamID, float fImpulseSqr=0.0f) const
bool IsBasedOn (const xiiSurfaceResource *pThisOrBaseSurface) const
bool IsBasedOn (const xiiSurfaceResourceHandle hThisOrBaseSurface) const
Public Member Functions inherited from xiiResource
XII_ALWAYS_INLINE xiiStringView GetResourceID () const
XII_ALWAYS_INLINE xiiUInt64 GetResourceIDHash () const
 Returns the hash of the unique ID.
void SetResourceDescription (xiiStringView sDescription)
const xiiString & GetResourceDescription () const
const xiiString & GetResourceIdOrDescription () const
XII_ALWAYS_INLINE xiiResourceState GetLoadingState () const
 Returns the current state in which this resource is in.
XII_ALWAYS_INLINE xiiUInt8 GetNumQualityLevelsDiscardable () const
XII_ALWAYS_INLINE xiiUInt8 GetNumQualityLevelsLoadable () const
 Returns how many quality levels the resource may additionally load.
float GetLoadingPriority (xiiTime now) const
 Returns the priority that is used by the resource manager to determine which resource to load next.
xiiResourcePriority GetPriority () const
 Returns the current resource priority.
void SetPriority (xiiResourcePriority priority)
 Changes the current resource priority.
XII_ALWAYS_INLINE const xiiBitflags< xiiResourceFlags > & GetBaseResourceFlags () const
 Returns the basic flags for the resource type. Mostly used the resource manager.
XII_ALWAYS_INLINE const MemoryUsage & GetMemoryUsage () const
 Returns the information about the current memory usage of the resource.
XII_ALWAYS_INLINE xiiTime GetLastAcquireTime () const
XII_ALWAYS_INLINE xiiInt32 GetReferenceCount () const
 Returns the reference count of this resource.
XII_ALWAYS_INLINE const xiiTimestamp & GetLoadedFileModificationTime () const
XII_ALWAYS_INLINE xiiUInt32 GetCurrentResourceChangeCounter () const
XII_ALWAYS_INLINE void IncResourceChangeCounter ()
 Allows to manually increase the resource change counter to signal that dependent code might need to update.
virtual void ResetResource ()
void PrintHandleStackTraces ()
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

void * m_pPhysicsMaterialPhysX = nullptr
void * m_pPhysicsMaterialJolt = nullptr
Public Attributes inherited from xiiResource
xiiEvent< const xiiResourceEvent &, xiiMutex > m_ResourceEvents

Static Public Attributes

static xiiEvent< const xiiSurfaceResourceEvent &, xiiMutex > s_Events

Private Member Functions

virtual xiiResourceLoadDescription UnloadData (Unload WhatToUnload) override
virtual xiiResourceLoadDescription UpdateContent (xiiStreamReader *Stream) override
virtual void UpdateMemoryUsage (MemoryUsage &out_NewMemoryUsage) override

Additional Inherited Members

Public Types inherited from xiiResource
enum class  DoUpdate : xiiUInt8 { OnMainThread = 0U , OnAnyThread }
 Specifies the thread type on which update operations should be performed. More...
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI * GetStaticRTTI ()
Protected Types inherited from xiiResource
enum class  Unload : xiiUInt8 { AllQualityLevels = 0U , OneQualityLevel }
Protected Member Functions inherited from xiiResource
 xiiResource (DoUpdate resourceUpdateThread, xiiUInt8 uiQualityLevelsLoadable)
 Default constructor.
virtual ~xiiResource ()
 virtual destructor.
MemoryUsage & ModifyMemoryUsage ()
 Non-const version for resources that want to write this variable directly.
void SetIsReloadable (bool bIsReloadable)
void SetHasLoadingFallback (bool bHasLoadingFallback)
 Used internally by the code injection macros.

Member Function Documentation

◆ InteractWithSurface()

bool xiiSurfaceResource::InteractWithSurface ( xiiWorld * pWorld,
xiiGameObjectHandle hObject,
const xiiVec3 & vPosition,
const xiiVec3 & vSurfaceNormal,
const xiiVec3 & vIncomingDirection,
const xiiTempHashedString & sInteraction,
const xiiUInt16 * pOverrideTeamID,
float fImpulseSqr = 0.0f ) const

Spawns the prefab that was defined for the given interaction at the given position and using the configured orientation. Returns false, if the interaction type was not defined in this surface or any of its base surfaces

Todo
do random deviation, make sure to clamp max deviation angle

◆ UnloadData()

xiiResourceLoadDescription xiiSurfaceResource::UnloadData ( Unload WhatToUnload)
overrideprivatevirtual

Requests the resource to unload another quality level. If bFullUnload is true, the resource should unload all data, because it is going to be deleted afterwards.

Implements xiiResource.

◆ UpdateContent()

xiiResourceLoadDescription xiiSurfaceResource::UpdateContent ( xiiStreamReader * pStream)
overrideprivatevirtual

Called whenever more data for the resource is available. The resource must read the stream to update it's data.

pStream may be nullptr in case the resource data could not be found.

Implements xiiResource.

◆ UpdateMemoryUsage()

void xiiSurfaceResource::UpdateMemoryUsage ( MemoryUsage & out_NewMemoryUsage)
overrideprivatevirtual

This function must be overridden by all resource types.

It has to compute the memory used by this resource. It is called by the resource manager whenever the resource's data has been loaded or unloaded.

Implements xiiResource.


The documentation for this class was generated from the following files:
  • /home/runner/work/XII/XII/Source/Engine/Core/Physics/SurfaceResource.h
  • /home/runner/work/XII/XII/Source/Engine/Core/Physics/Implementation/SurfaceResource.cpp