Photon Engine 2.0.0-beta
A physically based renderer.
Loading...
Searching...
No Matches
ph::AMaskedModel Class Reference

#include <AMaskedModel.h>

Inheritance diagram for ph::AMaskedModel:
ph::Actor ph::TSdlResourceBase< ESdlTypeCategory::Ref_Actor > ph::SdlResourceBase ph::ISdlResource

Public Member Functions

PreCookReport preCook (const CookingContext &ctx) const override
 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.
 
TransientVisualElement cook (const CookingContext &ctx, const PreCookReport &report) const override
 
void setMask (const std::shared_ptr< Image > &mask)
 
 PH_DEFINE_SDL_CLASS (TSdlOwnerClass< AMaskedModel >)
 
- Public Member Functions inherited from ph::Actor
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
 
ISdlResourceoperator= (const ISdlResource &rhs)=default
 
ISdlResourceoperator= (ISdlResource &&rhs)=default
 
virtual const SdlClassgetDynamicSdlClass () 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
 
TSdlResourceBaseoperator= (const TSdlResourceBase &rhs)=default
 
TSdlResourceBaseoperator= (TSdlResourceBase &&rhs)=default
 
- Protected Member Functions inherited from ph::SdlResourceBase
 SdlResourceBase ()
 
 SdlResourceBase (const SdlResourceBase &other)
 
 SdlResourceBase (SdlResourceBase &&other)=default
 
SdlResourceBaseoperator= (const SdlResourceBase &rhs)
 
SdlResourceBaseoperator= (SdlResourceBase &&rhs)=default
 
- Protected Member Functions inherited from ph::ISdlResource
 ISdlResource ()=default
 

Member Function Documentation

◆ cook()

TransientVisualElement ph::AMaskedModel::cook ( const CookingContext & ctx,
const PreCookReport & report ) const
overridevirtual

Implements ph::Actor.

◆ PH_DEFINE_SDL_CLASS()

ph::AMaskedModel::PH_DEFINE_SDL_CLASS ( TSdlOwnerClass< AMaskedModel > )
inline

◆ preCook()

PreCookReport ph::AMaskedModel::preCook ( const CookingContext & ctx) const
overridevirtual

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 from ph::Actor.

◆ setMask()

void ph::AMaskedModel::setMask ( const std::shared_ptr< Image > & mask)

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