Actor.h

Go to the documentation of this file.

#pragma once
 
#include "SDL/TSdlResourceBase.h"
#include "World/Foundation/TransientVisualElement.h"
#include "SDL/sdl_interface.h"
 
#include <Common/logging.h>
 
#include <string>
 
namespace ph { class PreCookReport; }
namespace ph { class CookingContext; }
namespace ph { class CookOrder; }
 
namespace ph
{
 
// General group for actor cooking process
PH_DECLARE_LOG_GROUP(ActorCooking);
 
class Actor : public TSdlResourceBase<ESdlTypeCategory::Ref_Actor>
{
public:
    virtual PreCookReport preCook(const CookingContext& ctx) const;
 
    virtual TransientVisualElement cook(const CookingContext& ctx, const PreCookReport& report) const = 0;
 
    virtual void postCook(const CookingContext& ctx, TransientVisualElement& element) const;
 
    virtual CookOrder getCookOrder() const;
 
    TransientVisualElement stagelessCook(const CookingContext& ctx) const;
 
    // TODO: may need a new method for cache generation (request this stage from precook?)
 
public:
    PH_DEFINE_SDL_CLASS(TSdlOwnerClass<Actor>)
    {
        ClassType clazz(std::string(sdl::category_to_string(CATEGORY)));
        clazz.docName("Actor");
        clazz.description(
            "Represents an entity in the scene. "
            "Every entity that participates in a scene is an actor.");
        return clazz;
    }
};
 
}// end namespace ph