API reference

prefab.h · C++ API

Browse entries grouped by interface file. Expand an entry for declarations, usage and version boundaries.

Read the related guide →

Entries retain declarations and sources. Runtime verification is recorded per entry; internal source candidates are not a promise of SDK delivery.

include/kui/engine/prefab.h
Prefab::name
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
const std::string& name() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:42

Report an issue with this entry →
Prefab::nodeCount
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
size_t nodeCount() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:49

Report an issue with this entry →
Prefab::Prefab
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
explicit Prefab(const std::string& name) : name_(name)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:40

Report an issue with this entry →
Prefab::Prefab
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
Prefab() = default;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:39

Report an issue with this entry →
Prefab::root
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
const PrefabNode& root() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:47

Report an issue with this entry →
Prefab::root
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
PrefabNode& root()

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:45

Report an issue with this entry →
Prefab::setName
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
void setName(const std::string& n)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:43

Report an issue with this entry →
Prefab::setSourcePath
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
void setSourcePath(const std::string& p)

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:54

Report an issue with this entry →
Prefab::sourcePath
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
const std::string& sourcePath() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:52

Report an issue with this entry →
PrefabRegistry::~PrefabRegistry
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
~PrefabRegistry() = default;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:74

Report an issue with this entry →
PrefabRegistry::clear
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
void clear()

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:94

Report an issue with this entry →
PrefabRegistry::count
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
size_t count() const

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:91

Report an issue with this entry →
PrefabRegistry::createFromEntity
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
std::shared_ptr<Prefab> createFromEntity(const World& world, const SceneGraph& sceneGraph, Entity entity, const std::string& prefabName) const;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:97

Report an issue with this entry →
PrefabRegistry::getPrefab
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
std::shared_ptr<Prefab> getPrefab(const std::string& name) const;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:79

Report an issue with this entry →
PrefabRegistry::hasPrefab
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
bool hasPrefab(const std::string& name) const;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:82

Report an issue with this entry →
PrefabRegistry::instantiate
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
Entity instantiate(World& world, SceneGraph& sceneGraph, const Prefab& prefab, SceneNode* parentNode = nullptr) const;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:103

Report an issue with this entry →
PrefabRegistry::prefabNames
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
std::vector<std::string> prefabNames() const;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:88

Report an issue with this entry →
PrefabRegistry::PrefabRegistry
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
PrefabRegistry() = default;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:73

Report an issue with this entry →
PrefabRegistry::registerComponentHandler
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
void registerComponentHandler(const std::string& typeName, SerializeFn ser, DeserializeFn deser);

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:114

Report an issue with this entry →
PrefabRegistry::registerPrefab
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
void registerPrefab(const std::string& name, std::shared_ptr<Prefab> prefab);

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:76

Report an issue with this entry →
PrefabRegistry::removePrefab
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
void removePrefab(const std::string& name);

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:85

Report an issue with this entry →
PrefabRegistry::SerializedComponent
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
using SerializeFn = std::function<SerializedComponent(const World& world, Entity entity)>;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:112

Report an issue with this entry →
PrefabRegistry::void
Off by default3.61.7C++

Installed header declaration in the engine module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements. This belongs to the legacy in-tree 3D module. KUI_ENABLE_3D_ENGINE is off by default; new projects should use the standalone kui_ext_3d extension.

prefab.h
using DeserializeFn = std::function<void(World& world, Entity entity, const SerializedComponent& data)>;

Conditions: KUI_ENABLE_3D_ENGINE=ON

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/engine/prefab.h:109

Report an issue with this entry →
Browse this reference type →