Class uipc::core::Scene

ClassList > uipc > core > Scene

Classes

Type	Name
class	CGeometries
class	CObjects
class	ConfigAttributesT <IsConst>
class	Geometries
class	Objects

Public Types

Type	Name
typedef ConfigAttributesT< true >	CConfigAttributes
typedef ConfigAttributesT< false >	ConfigAttributes

Public Functions

Type	Name
	Scene (const Json & config=default_config())
	Scene (S< internal::Scene > scene) noexcept
	Scene (const Scene &) = delete
	Scene (Scene &&) = default
Animator &	animator ()
const Animator &	animator () const
ConfigAttributes	config () noexcept
CConfigAttributes	config () noexcept const
ConstitutionTabular &	constitution_tabular () noexcept
const ConstitutionTabular &	constitution_tabular () noexcept const
ContactTabular &	contact_tabular () noexcept
const ContactTabular &	contact_tabular () noexcept const
DiffSim &	diff_sim ()
const DiffSim &	diff_sim () const
Geometries	geometries () noexcept
CGeometries	geometries () noexcept const
Objects	objects () noexcept
CObjects	objects () noexcept const
SubsceneTabular &	subscene_tabular () noexcept
const SubsceneTabular &	subscene_tabular () noexcept const
void	update_from (const SceneSnapshotCommit & snapshot)
void	validate_config () const Validate the current mutable configuration against config_schema() .
	~Scene ()

Public Static Functions

Type	Name
Json	config_schema () Return machine-readable metadata for every registered scene config key.
Json	default_config () noexcept

Public Types Documentation

typedef CConfigAttributes

using uipc::core::Scene::CConfigAttributes =  ConfigAttributesT<true>;

---

typedef ConfigAttributes

using uipc::core::Scene::ConfigAttributes =  ConfigAttributesT<false>;

---

Public Functions Documentation

function Scene [1/4]

explicit uipc::core::Scene::Scene (
    const Json & config=default_config()
) 

---

function Scene [2/4]

explicit uipc::core::Scene::Scene (
    S< internal::Scene > scene
) noexcept

---

function Scene [3/4]

uipc::core::Scene::Scene (
    const Scene &
) = delete

---

function Scene [4/4]

uipc::core::Scene::Scene (
    Scene &&
) = default

---

function animator [1/2]

Animator & uipc::core::Scene::animator () 

---

function animator [2/2]

const Animator & uipc::core::Scene::animator () const

---

function config [1/2]

ConfigAttributes uipc::core::Scene::config () noexcept

---

function config [2/2]

CConfigAttributes uipc::core::Scene::config () noexcept const

---

function constitution_tabular [1/2]

ConstitutionTabular & uipc::core::Scene::constitution_tabular () noexcept

---

function constitution_tabular [2/2]

const ConstitutionTabular & uipc::core::Scene::constitution_tabular () noexcept const

---

function contact_tabular [1/2]

ContactTabular & uipc::core::Scene::contact_tabular () noexcept

---

function contact_tabular [2/2]

const ContactTabular & uipc::core::Scene::contact_tabular () noexcept const

---

function diff_sim [1/2]

DiffSim & uipc::core::Scene::diff_sim () 

---

function diff_sim [2/2]

const DiffSim & uipc::core::Scene::diff_sim () const

---

function geometries [1/2]

Geometries uipc::core::Scene::geometries () noexcept

---

function geometries [2/2]

CGeometries uipc::core::Scene::geometries () noexcept const

---

function objects [1/2]

Objects uipc::core::Scene::objects () noexcept

---

function objects [2/2]

CObjects uipc::core::Scene::objects () noexcept const

---

function subscene_tabular [1/2]

SubsceneTabular & uipc::core::Scene::subscene_tabular () noexcept

---

function subscene_tabular [2/2]

const SubsceneTabular & uipc::core::Scene::subscene_tabular () noexcept const

---

function update_from

void uipc::core::Scene::update_from (
    const SceneSnapshotCommit & snapshot
) 

---

function validate_config

Validate the current mutable configuration against config_schema() .

void uipc::core::Scene::validate_config () const

Construction validates the input JSON. World::init validates again so edits made through config() cannot silently bypass the contract.

---

function ~Scene

uipc::core::Scene::~Scene () 

---

Public Static Functions Documentation

function config_schema

Return machine-readable metadata for every registered scene config key.

static Json uipc::core::Scene::config_schema () 

Each entry includes its default, storage/type information, constraints, lifecycle, status, description, and backend consumer locations.

---

function default_config

static Json uipc::core::Scene::default_config () noexcept

---

Friends Documentation

friend SceneVisitor

class uipc::core::Scene::SceneVisitor (
    backend::SceneVisitor
) 

---

friend formatter< Scene >

struct uipc::core::Scene::formatter< Scene > (
    fmt::formatter< Scene >
) 

---

friend SanityChecker

class uipc::core::Scene::SanityChecker (
    sanity_check::SanityChecker
) 

---

---

The documentation for this class was generated from the following file include/uipc/core/scene.h