ezEngine  Release 25.03
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
ezSkeletonContext Class Reference
Inheritance diagram for ezSkeletonContext:
Inheritance graph
[legend]

Public Member Functions

virtual void HandleMessage (const ezEditorEngineDocumentMsg *pMsg) override
 
ezSkeletonResourceHandle GetSkeleton () const
 
- Public Member Functions inherited from ezEngineProcessDocumentContext
 ezEngineProcessDocumentContext (ezBitflags< ezEngineProcessDocumentContextFlags > flags)
 
virtual void Initialize (const ezUuid &documentGuid, const ezVariant &metaData, ezEngineProcessCommunicationChannel *pIPC, ezStringView sDocumentType)
 
void Deinitialize ()
 
ezStringView GetDocumentType () const
 Returns the document type for which this context was created. Useful in case a context may be used for multiple document types.
 
void SendProcessMessage (ezProcessMessage *pMsg=nullptr)
 
ezBoundingBoxSphere GetWorldBounds (ezWorld *pWorld)
 
void ProcessEditorEngineSyncObjectMsg (const ezEditorEngineSyncObjectMsg &msg)
 
const ezUuid & GetDocumentGuid () const
 
virtual void Reset ()
 
void ClearExistingObjects ()
 
virtual ezWorldRttiConverterContext & GetContext ()
 
virtual const ezWorldRttiConverterContext & GetContext () const
 
ezWorld * GetWorld () const
 
virtual ezGameObjectHandle ResolveStringToGameObjectHandle (const void *pString, ezComponentHandle hThis, ezStringView sProperty) const
 Tries to resolve a 'reference' (given in pData) to an ezGameObject. More...
 
- Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI * GetDynamicRTTI () const
 
bool IsInstanceOf (const ezRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T >
EZ_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Public Attributes

bool m_bDisplayGrid = true
 
- Public Attributes inherited from ezEngineProcessDocumentContext
ezIPCObjectMirrorEngine m_Mirror
 
ezWorldRttiConverterContext m_Context
 

Protected Member Functions

virtual void OnInitialize () override
 
virtual ezEngineProcessViewContext * CreateViewContext () override
 Needs to be implemented to create a view context used for windows and thumbnails rendering.
 
virtual void DestroyViewContext (ezEngineProcessViewContext *pContext) override
 Needs to be implemented to destroy the view context created in CreateViewContext.
 
virtual bool UpdateThumbnailViewContext (ezEngineProcessViewContext *pThumbnailViewContext) override
 Overwrite this function to apply the thumbnail render settings to the given context. More...
 
- Protected Member Functions inherited from ezEngineProcessDocumentContext
virtual void OnDeinitialize ()
 
virtual bool PendingOperationInProgress () const
 Should return true if this context has any operation in progress like thumbnail rendering and thus needs to continue rendering even if no new messages from the editor come in.
 
virtual void UpdateDocumentContext ()
 A tick functions that allows each document context to do processing that continues over multiple frames and can't be handled in HandleMessage directly. More...
 
virtual ezStatus ExportDocument (const ezExportDocumentMsgToEngine *pMsg)
 Exports to current document resource to file. Make sure to write ezAssetFileHeader at the start of it.
 
void UpdateSyncObjects ()
 
void CreateThumbnailViewContext (const ezCreateThumbnailMsgToEngine *pMsg)
 Creates the thumbnail view context. It uses 'CreateViewContext' in combination with an off-screen render target.
 
void DestroyThumbnailViewContext ()
 Once a thumbnail is successfully rendered, the thumbnail view context is destroyed again.
 
virtual void OnThumbnailViewContextRequested ()
 Called before a thumbnail context is created.
 
virtual void OnThumbnailViewContextCreated ()
 Called after a thumbnail context was created. Allows to insert code before the thumbnail is generated.
 
virtual void OnDestroyThumbnailViewContext ()
 Called before a thumbnail context is destroyed. Used for cleanup of what was done in OnThumbnailViewContextCreated()
 
void SetTagOnObject (const ezUuid &object, const char *szTag, bool bSet, bool recursive)
 Sets or removes the given tag on the object and optionally all children.
 
void SetTagRecursive (ezGameObject *pObject, const ezTag &tag)
 Sets the given tag on the object and all children.
 
void ClearTagRecursive (ezGameObject *pObject, const ezTag &tag)
 Clears the given tag on the object and all children.
 
const ezEngineProcessViewContext * GetViewContext (ezUInt32 uiView) const
 

Additional Inherited Members

- Static Public Member Functions inherited from ezEngineProcessDocumentContext
static ezEngineProcessDocumentContext * GetDocumentContext (ezUuid guid)
 
static void AddDocumentContext (ezUuid guid, const ezVariant &metaData, ezEngineProcessDocumentContext *pView, ezEngineProcessCommunicationChannel *pIPC, ezStringView sDocumentType)
 
static bool PendingOperationsInProgress ()
 
static void UpdateDocumentContexts ()
 
static void DestroyDocumentContext (ezUuid guid)
 
- Static Public Member Functions inherited from ezNoBase
static const ezRTTI * GetStaticRTTI ()
 
- Protected Attributes inherited from ezEngineProcessDocumentContext
ezWorld * m_pWorld = nullptr
 
ezBitflags< ezEngineProcessDocumentContextFlags > m_Flags
 
ezUuid m_DocumentGuid
 
ezVariant m_MetaData
 
ezEngineProcessCommunicationChannel * m_pIPC = nullptr
 
ezHybridArray< ezEngineProcessViewContext *, 4 > m_ViewContexts
 
ezMap< ezUuid, ezEditorEngineSyncObject * > m_SyncObjects
 

Member Function Documentation

◆ UpdateThumbnailViewContext()

bool ezSkeletonContext::UpdateThumbnailViewContext ( ezEngineProcessViewContext *  pThumbnailViewContext)
overrideprotectedvirtual

Overwrite this function to apply the thumbnail render settings to the given context.

Return false if you need more frames to be rendered to setup everything correctly. If true is returned for 'ThumbnailConvergenceFramesTarget' frames in a row the thumbnail image is taken. This is to allow e.g. camera updates after more resources have been streamed in. The frame counter will start over to count to 'ThumbnailConvergenceFramesTarget' when a new resource is being loaded to make sure we do not make an image of half-streamed in data.

Reimplemented from ezEngineProcessDocumentContext.

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