ph::Actor Class Reference

#include <Actor.h>

Inheritance diagram for ph::Actor:

Public Member Functions
virtual PreCookReport	preCook (const CookingContext &ctx) const
	Cooking supplemental data before cook(). This method allows user to specify additional configurations for the following cooking process. This method may run in parallel without taking into account resource dependencies.
virtual TransientVisualElement	cook (const CookingContext &ctx, const PreCookReport &report) const =0
virtual void	postCook (const CookingContext &ctx, TransientVisualElement &element) const
	Cooking additional data after cook(). This method provides an opportunity for user to decorate the cooked data or any post-cook operations (such as generating debug data). This method may run in parallel without taking into account resource dependencies.
virtual CookOrder	getCookOrder () const
TransientVisualElement	stagelessCook (const CookingContext &ctx) const
	Helper to execute the full cooking procedure in one go.
	PH_DEFINE_SDL_CLASS (TSdlOwnerClass< Actor >)
Public Member Functions inherited from ph::TSdlResourceBase< ESdlTypeCategory::Ref_Actor >
ESdlTypeCategory	getDynamicCategory () const override
Public Member Functions inherited from ph::SdlResourceBase
SdlResourceId	getId () const override
	Get the unique ID of this resource. The returned ID is guaranteed to be unique in the current process. Newly created resource cannot have an ID that has been used by a previous resource, even if the previous resource has ended its life cycle. See SdlResourceId.h for some utilities.
Public Member Functions inherited from ph::ISdlResource
	ISdlResource (const ISdlResource &other)=default
	ISdlResource (ISdlResource &&other)=default
virtual	~ISdlResource ()=default
ISdlResource &	operator= (const ISdlResource &rhs)=default
ISdlResource &	operator= (ISdlResource &&rhs)=default
virtual const SdlClass *	getDynamicSdlClass () const
	Get runtime SDL class of the resource.
virtual bool	isInlinable () const

Additional Inherited Members
Static Public Attributes inherited from ph::TSdlResourceBase< ESdlTypeCategory::Ref_Actor >
static constexpr ESdlTypeCategory	CATEGORY
	Static category information of the resource. This static category information is required by ISdlResource. See its documentation for more details.
Protected Member Functions inherited from ph::TSdlResourceBase< ESdlTypeCategory::Ref_Actor >
	TSdlResourceBase ()=default
	TSdlResourceBase (const TSdlResourceBase &other)=default
	TSdlResourceBase (TSdlResourceBase &&other)=default
TSdlResourceBase &	operator= (const TSdlResourceBase &rhs)=default
TSdlResourceBase &	operator= (TSdlResourceBase &&rhs)=default
Protected Member Functions inherited from ph::SdlResourceBase
	SdlResourceBase ()
	SdlResourceBase (const SdlResourceBase &other)
	SdlResourceBase (SdlResourceBase &&other)=default
SdlResourceBase &	operator= (const SdlResourceBase &rhs)
SdlResourceBase &	operator= (SdlResourceBase &&rhs)=default
Protected Member Functions inherited from ph::ISdlResource
	ISdlResource ()=default

Member Function Documentation

cook()

virtual TransientVisualElement ph::Actor::cook ( const CookingContext & ctx, const PreCookReport & report ) const

pure virtual

Implemented in ph::ADome, ph::AGeometricLight, ph::AIesAttenuatedLight, ph::ALight, ph::AMaskedModel, ph::AModel, ph::APhantomModel, ph::ATransformedInstance, and ph::PhysicalActor.

getCookOrder()

CookOrder ph::Actor::getCookOrder ( ) const

virtual

Reimplemented in ph::ADome, and ph::APhantomModel.

PH_DEFINE_SDL_CLASS()

ph::Actor::PH_DEFINE_SDL_CLASS ( TSdlOwnerClass< Actor > )

inline

postCook()

void ph::Actor::postCook ( const CookingContext & ctx, TransientVisualElement & element ) const

virtual

Cooking additional data after cook(). This method provides an opportunity for user to decorate the cooked data or any post-cook operations (such as generating debug data). This method may run in parallel without taking into account resource dependencies.

preCook()

PreCookReport ph::Actor::preCook ( const CookingContext & ctx ) const

virtual

Cooking supplemental data before cook(). This method allows user to specify additional configurations for the following cooking process. This method may run in parallel without taking into account resource dependencies.

Reimplemented in ph::ADome, ph::AGeometricLight, ph::AIesAttenuatedLight, ph::AMaskedModel, and ph::AModel.

stagelessCook()

TransientVisualElement ph::Actor::stagelessCook

(

const CookingContext &

ctx

)

const

Helper to execute the full cooking procedure in one go.

---

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

• Source/Actor/Actor.h
• Source/Actor/Actor.cpp