Program Listing for File GraphicalScene.h

Program Listing for File GraphicalScene.h#

↰ Return to documentation for file (include/Karana/Scene/GraphicalScene.h)

/*
*Copyright(c)2024-2026KaranaDynamicsPtyLtd.Allrightsreserved.
*
*NOTICETOUSER:
*
*Thissourcecodeand/ordocumentation(the"LicensedMaterials")is
*theconfidentialandproprietaryinformationofKaranaDynamicsInc.
*UseoftheseLicensedMaterialsisgovernedbythetermsandconditions
*ofaseparatesoftwarelicenseagreementbetweenKaranaDynamicsandthe
*Licensee("LicenseAgreement").Unlessexpresslypermittedunderthat
*agreement,anyreproduction,modification,distribution,ordisclosure
*oftheLicensedMaterials,inwholeorinpart,toanythirdparty
*withoutthepriorwrittenconsentofKaranaDynamicsisstrictlyprohibited.
*
*THELICENSEDMATERIALSAREPROVIDED"ASIS"WITHOUTWARRANTYOFANYKIND.
*KARANADYNAMICSDISCLAIMSALLWARRANTIES,EXPRESSORIMPLIED,INCLUDING
*BUTNOTLIMITEDTOWARRANTIESOFMERCHANTABILITY,NON-INFRINGEMENT,AND
*FITNESSFORAPARTICULARPURPOSE.
*
*INNOEVENTSHALLKARANADYNAMICSBELIABLEFORANYDAMAGESWHATSOEVER,
*INCLUDINGBUTNOTLIMITEDTOLOSSOFPROFITS,DATA,ORUSE,EVENIF
*ADVISEDOFTHEPOSSIBILITYOFSUCHDAMAGES,WHETHERINCONTRACT,TORT,
*OROTHERWISEARISINGOUTOFORINCONNECTIONWITHTHELICENSEDMATERIALS.
*
*U.S.GovernmentEndUsers:TheLicensedMaterialsarea"commercialitem"
*asdefinedat48C.F.R.2.101,andareprovidedtotheU.S.Government
*onlyasacommercialenditemunderthetermsofthislicense.
*
*AnyuseoftheLicensedMaterialsinindividualorcommercialsoftwaremust
*include,intheuserdocumentationandinternalsourcecodecomments,
*thisNotice,Disclaimer,andU.S.GovernmentUseProvision.
*/


#pragmaonce
#include"Karana/Scene/GraphicalSceneCamera.h"
#include"Karana/Scene/GraphicalSceneNode.h"
#include"Karana/Scene/GraphicalScenePart.h"
#include"Karana/Scene/Scene.h"
#include"Karana/Scene/Text.h"

namespaceKarana::Scene{

structRGBABuffer{
std::vector<uint8_t>data;
unsignedintwidth;
unsignedintheight;
};

classGraphicalScene:publicScene{

//Forcreate/discard
friendclassGraphicalSceneNode;
friendclassGraphicalScenePart;

protected:
GraphicalScene(std::string_viewname);

public:
virtual~GraphicalScene();

virtualKarana::Core::ks_ptr<GraphicalSceneCamera>defaultCamera()const=0;

virtualvoidrenderToFile(conststd::filesystem::path&filepath)=0;

virtualKarana::Core::id_t
addOverlayText(std::string_viewmessage,
floatx,
floaty,
constTextParameters&parameters=TextParameters{})=0;

virtualvoidsetOverlayText(constKarana::Core::id_t&id,std::string_viewmessage)=0;

virtualvoidremoveOverlayText(constKarana::Core::id_t&id)=0;
};
}//namespaceKarana::Scene