XII Release 0.1.0
Loading...
Searching...
No Matches
xiiSelectedObjectsExtractor Class Reference

An extractor that can be instantiated in a render pipeline, to define manually which objects should be rendered with a selection outline. More...

#include <Extractor.h>

Inheritance diagram for xiiSelectedObjectsExtractor:
[legend]

Public Member Functions

 xiiSelectedObjectsExtractor (xiiStringView sName="ExplicitlySelectedObjectsExtractor")
 
virtual const xiiDeque< xiiGameObjectHandle > * GetSelection () override
 
virtual xiiResult Serialize (xiiStreamWriter &inout_stream) const override
 
virtual xiiResult Deserialize (xiiStreamReader &inout_stream) override
 
void SetSelectionContext (xiiSelectedObjectsContext *pSelectionContext)
 The context is typically set through a xiiView, through xiiView::SetExtractorProperty("<name>", "SelectionContext", pointer);.
 
xiiSelectedObjectsContextGetSelectionContext () const
 
- Public Member Functions inherited from xiiSelectedObjectsExtractorBase
 xiiSelectedObjectsExtractorBase (xiiStringView sName="SelectedObjectsExtractor")
 
virtual void Extract (const xiiView &view, const xiiDynamicArray< const xiiGameObject * > &visibleObjects, xiiExtractedRenderData &ref_extractedRenderData) override
 
virtual void PostSortAndBatch (const xiiView &view, const xiiDynamicArray< const xiiGameObject * > &visibleObjects, xiiExtractedRenderData &ref_extractedRenderData) override
 
- Public Member Functions inherited from xiiExtractor
 xiiExtractor (xiiStringView sName)
 
void SetName (xiiStringView sName)
 Sets the name of the extractor.
 
xiiStringView GetName () const
 returns the name of the extractor.
 
- Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTIGetDynamicRTTI () 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from xiiNoBase
static const xiiRTTIGetStaticRTTI ()
 
- Public Attributes inherited from xiiSelectedObjectsExtractorBase
xiiRenderData::Category m_OverrideCategory
 
- Protected Member Functions inherited from xiiExtractor
bool FilterByViewTags (const xiiView &view, const xiiGameObject *pObject) const
 returns true if the given object should be filtered by view tags.
 
void ExtractRenderData (const xiiView &view, const xiiGameObject *pObject, xiiMsgExtractRenderData &msg, xiiExtractedRenderData &extractedRenderData) const
 extracts the render data for the given object.
 
- Protected Attributes inherited from xiiExtractor
xiiHybridArray< xiiHashedString, 4 > m_DependsOn
 

Detailed Description

An extractor that can be instantiated in a render pipeline, to define manually which objects should be rendered with a selection outline.

See also
xiiSelectedObjectsContext

Member Function Documentation

◆ Deserialize()

xiiResult xiiSelectedObjectsExtractor::Deserialize ( xiiStreamReader & inout_stream)
overridevirtual

Reimplemented from xiiExtractor.

◆ GetSelection()

const xiiDeque< xiiGameObjectHandle > * xiiSelectedObjectsExtractor::GetSelection ( )
overridevirtual

◆ Serialize()

xiiResult xiiSelectedObjectsExtractor::Serialize ( xiiStreamWriter & inout_stream) const
overridevirtual

Reimplemented from xiiExtractor.


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