plSelectedObjectsExtractor 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 plSelectedObjectsExtractor:

Public Member Functions
	plSelectedObjectsExtractor (const char *szName="ExplicitlySelectedObjectsExtractor")
virtual const plDeque< plGameObjectHandle > *	GetSelection () override
virtual plResult	Serialize (plStreamWriter &inout_stream) const override
virtual plResult	Deserialize (plStreamReader &inout_stream) override
void	SetSelectionContext (plSelectedObjectsContext *pSelectionContext)
	The context is typically set through an plView, through plView::SetExtractorProperty("<name>", "SelectionContext", pointer);.
plSelectedObjectsContext *	GetSelectionContext () const
Public Member Functions inherited from plSelectedObjectsExtractorBase
	plSelectedObjectsExtractorBase (const char *szName="SelectedObjectsExtractor")
virtual void	Extract (const plView &view, const plDynamicArray< const plGameObject * > &visibleObjects, plExtractedRenderData &ref_extractedRenderData) override
Public Member Functions inherited from plExtractor
	plExtractor (const char *szName)
void	SetName (const char *szName)
	Sets the name of the extractor.
const char *	GetName () const
	returns the name of the extractor.
virtual void	PostSortAndBatch (const plView &view, const plDynamicArray< const plGameObject * > &visibleObjects, plExtractedRenderData &ref_extractedRenderData)
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.

Additional Inherited Members
Static Public Member Functions inherited from plNoBase
static const plRTTI *	GetStaticRTTI ()
Public Attributes inherited from plSelectedObjectsExtractorBase
plRenderData::Category	m_OverrideCategory
Protected Member Functions inherited from plExtractor
bool	FilterByViewTags (const plView &view, const plGameObject *pObject) const
	returns true if the given object should be filtered by view tags.
void	ExtractRenderData (const plView &view, const plGameObject *pObject, plMsgExtractRenderData &msg, plExtractedRenderData &extractedRenderData) const
	extracts the render data for the given object.
Protected Attributes inherited from plExtractor
plHybridArray< plHashedString, 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

plSelectedObjectsContext

Member Function Documentation

Deserialize()

plResult plSelectedObjectsExtractor::Deserialize ( plStreamReader & inout_stream )

overridevirtual

Reimplemented from plExtractor.

GetSelection()

const plDeque< plGameObjectHandle > * plSelectedObjectsExtractor::GetSelection ( )

overridevirtual

Implements plSelectedObjectsExtractorBase.

Serialize()

plResult plSelectedObjectsExtractor::Serialize ( plStreamWriter & inout_stream ) const

overridevirtual

Reimplemented from plExtractor.

---

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

• Code/Engine/RendererCore/Pipeline/Extractor.h
• Code/Engine/RendererCore/Pipeline/Implementation/Extractor.cpp