Skip to content

EPOK RUNTIME

Object Model

object_model.hpp · the object model module

Module

the object model module.

Header: object_model.hpp
Include: #include "object_model.hpp"
Stability: Epok runtime API

Include this module

C++ include

#include "object_model.hpp"

Types

ActorClass declared by the object-model module for the object model module.Class Actor2DClass declared by the object-model module for the object model module.Class Actor3DClass declared by the object-model module for the object model module.Class ActorComponentClass declared by the object-model module for the object model module.Class ActorPrepareFn---- spawning ------------------------------------------------------------------ Preparation hook, run once per reserved actor after its defaults, root, owner and registration are in place and *before* any `begin_play` of this batch (design.md section 6, between steps 2 and 5).Type alias ActorSpawnRequestOne spawn request.Struct AudioComponentShared audio without a transform.Class BlobShadowComponentClass declared by the object-model module for the object model module.Class Camera3DComponentClass declared by the object-model module for the object model module.Class CanvasComponentClass declared by the object-model module for the object model module.Class ClassDescriptorCooked class table.Struct Collider3DComponentClass declared by the object-model module for the object model module.Class EndPlayReasonEnum declared by the object-model module for the object model module.Enum ImageComponentClass declared by the object-model module for the object model module.Class LevelClass declared by the object-model module for the object model module.Class LevelPendingOpOne queued spawn/destroy request, executed when the current batch finishes.Struct Light3DComponentClass declared by the object-model module for the object model module.Class Mesh3DComponentNative components register their ownership with the Actor lifecycle.Class NativeComponentDefaultStruct declared by the object-model module for the object model module.Struct ObjectClass declared by the object-model module for the object model module.Class ObjectClassFlagsClass descriptor flags.Enum ObjectDispatchScopeStorage of a destroyed object stays quarantined until every nested callback returns.Struct ObjectDomainEnum declared by the object-model module for the object model module.Enum ObjectFamilyEnum declared by the object-model module for the object model module.Enum ObjectIdCompact runtime identity.Struct ObjectPoolFixed typed storage for one concrete class.Class template ObjectRegistrySlot table over a fixed capacity.Struct ObjectRegistryStorageDefault capacity for a cooked build; tests instantiate a small table.Class template ObjectSlotStruct declared by the object-model module for the object model module.Struct ObjectStateEnum declared by the object-model module for the object model module.Enum ObjectStatsStruct declared by the object-model module for the object model module.Struct PaletteAnimatorComponentClass declared by the object-model module for the object model module.Class ParticleEffectComponentClass declared by the object-model module for the object model module.Class ParticleEmitterComponentClass declared by the object-model module for the object model module.Class ProgressBarComponentClass declared by the object-model module for the object model module.Class RectTransformComponentClass declared by the object-model module for the object model module.Class SceneComponent2DClass declared by the object-model module for the object model module.Class SceneComponent3DClass declared by the object-model module for the object model module.Class SceneScriptActorOne per loaded Level.Class Sprite3DComponentClass declared by the object-model module for the object model module.Class TextComponentClass declared by the object-model module for the object model module.Class TimelineComponentClass declared by the object-model module for the object model module.Class Transform2D2D world transform: XY position, rotation about the view axis, per-axis scale and a stable draw order.Struct UIActorClass declared by the object-model module for the object model module.Class UIComponentClass declared by the object-model module for the object model module.Class WorldClass declared by the object-model module for the object model module.Class

Functions and methods

~ObjectReleases the resources owned by `epok::Object`.destructor ~ObjectDispatchScopeReleases the resources owned by `epok::ObjectDispatchScope`.destructor acquirePerforms `acquire` as part of the object model module.Method acquirePool-backed construction of a concrete class.Method activeSelf flag only; Level::actor_active() folds the logical parent chain.Method actor_active---- activation ----------------------------------------------------------------Method actor_atPerforms `actor at` as part of the object model module.Method actor_countPerforms `actor count` as part of the object model module.Method add_component---- components ----------------------------------------------------------------Function template adoptAdopt storage owned by somebody else (an actor's embedded default component, the Level itself).Method attach_componentSpatial attachment between components of the same domain.Function attach_slotPerforms `attach slot` as part of the object model module.Method attach_slotPerforms `attach slot` as part of the object model module.Method attach_slotPerforms `attach slot` as part of the object model module.Method attach_slotPerforms `attach slot` as part of the object model module.Method begin_playBegins play as part of the object model module.Method begin_playBegins play as part of the object model module.Method begin_playplay_on_start policy.Method bindBinds the slot table and registers the Level itself.Method bindPerforms `bind` as part of the object model module.Method bind_dataPerforms `bind data` as part of the object model module.Method bind_localPerforms `bind local` as part of the object model module.Method bind_localPerforms `bind local` as part of the object model module.Method bind_localNo legacy slot: the component owns the transform.Method bind_slotBind to the legacy slot's AudioSource, or to component-owned storage.Method bind_slotPerforms `bind slot` as part of the object model module.Method bind_slotCanonical storage: the legacy entity slot owns the transform and everything that already reads it (collision, rendering, motion interpolation) keeps working.Method blueprint_observePerforms `blueprint observe` as part of the object model module.Method blueprint_observePerforms `blueprint observe` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idRuntime-owned identity hooks; not an authoring API.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_idPerforms `class id` as part of the object model module.Method class_ofPerforms `class of` as part of the object model module.Method collect_quarantinedRetry the quarantined slots.Method compact_class_idSingle-block SHA-256: enough for a 36 character UUID (message + padding <= 64 bytes).Function component_countPerforms `component count` as part of the object model module.Method component_idPerforms `component id` as part of the object model module.Method create_scene_scriptThe scene script is created by the loader; it is never part of the actor table.Method dataLegacy adapter: the canonical slot behind the root scene component, or nullptr.Method default_rootRuntime hook, not reflected: the declarative root component embedded in the actor.Method default_rootPerforms `default root` as part of the object model module.Method default_rootPerforms `default root` as part of the object model module.Method default_rootPerforms `default root` as part of the object model module.Method destroyDestroys destroy as part of the object model module.Method destroy_actor---- destruction --------------------------------------------------------------- A request made inside a callback marks the actor immediately (it receives no further events) and runs the teardown when the current batch finishes.Method dispatch_triggerCollision is owned by the spatial services, not by the Level: they resolve the legacy slot to its actor and call this, which fans the event out to the owner's components in registration order.Function end_playEnds play as part of the object model module.Method end_playEnds play as part of the object model module.Method end_playEnds play as part of the object model module.Method end_play_allExit order: scene script first while the actors are still alive, then every actor.Method entity_slotPerforms `entity slot` as part of the object model module.Method entity_slotPerforms `entity slot` as part of the object model module.Method entity_slotPerforms `entity slot` as part of the object model module.Method find_object_classFinds object class as part of the object model module.Function finish_releaseCalled when the last dispatch scope unwinds: no callback can still be on the stack of a destroyed object, so its typed storage returns to the pool.Method frame_updatePerforms `frame update` as part of the object model module.Method frame_updateOnce per rendered frame, even while paused (legacy Behaviour parity).Method getReturns get as part of the object model module.Method getReturns get as part of the object model module.Method get_componentReturns component as part of the object model module.Function template get_componentsReturns components as part of the object model module.Function template get_ownerReturns owner as part of the object model module.Method idPerforms `id` as part of the object model module.Method is_aReports whether a as part of the object model module.Method is_playingReports whether playing as part of the object model module.Method level_idReflected identity/hierarchy readers.Method livePerforms `live` as part of the object model module.Method livePerforms `live` as part of the object model module.Method logical_parentPerforms `logical parent` as part of the object model module.Method namePerforms `name` as part of the object model module.Method namePerforms `name` as part of the object model module.Method next_generationPerforms `next generation` as part of the object model module.Method object_class_is_aAncestry walk bounded by the table size; the cook rejects cycles before emitting.Function object_constructPlacement-new into caller storage; destroy runs the virtual destructor of the concrete type, so a base pointer never slices.Function template object_destructPerforms `object destruct` as part of the object model module.Function object_domain_bitOwner domain masks for components.Function object_storage_quarantinedDefined after AudioComponent; `false` for every object that owns no retained storage.Function ObjectDispatchScopeConstructs `epok::ObjectDispatchScope` for the object model module.constructor ObjectRegistryConstructs `epok::ObjectRegistry` for the object model module.constructor ObjectRegistryStorage<Capacity>Constructs `epok::ObjectRegistryStorage` for the object model module.constructor on_disablePerforms `on disable` as part of the object model module.Method on_disablePerforms `on disable` as part of the object model module.Method on_disableDeactivation and teardown stop both kinds: lifecycle.hpp::set_active stops a legacy slot's audio through the slot table, and stopping an already stopped source is a no-op, so the two paths are idempotent rather than conflicting.Method on_enablePerforms `on enable` as part of the object model module.Method on_enablePerforms `on enable` as part of the object model module.Method on_triggerForward-only collision hook.Method operator!=Performs `operator !=` as part of the object model module.Method operator=Performs `operator =` as part of the object model module.Method operator=Performs `operator =` as part of the object model module.Method operator==Performs `operator ==` as part of the object model module.Method owner_idPerforms `owner id` as part of the object model module.Method owns_sourceTrue only for component-owned storage.Method playStarts play as part of the object model module.Method registryPerforms `registry` as part of the object model module.Method releasableFalse while a service still holds this component's storage; the registry then keeps the (already dead) slot quarantined instead of returning it to the pool.Method releasableComponent-owned storage stays quarantined while an asynchronous consumer (the XA music service) still points at it, mirroring allocate_actor_data's legacy-slot rule.Method releasePerforms `release` as part of the object model module.Method releaseInvalidates the handle immediately; storage is quarantined while callbacks run.Method remove_componentRemoves component as part of the object model module.Method resolveGeneration and class checked; the runtime class must derive from T's static class.Function template root_idPerforms `root id` as part of the object model module.Method scene_scriptPerforms `scene script` as part of the object model module.Method set_activeFolded activation with the on_enable/on_disable fan-out, and deferred destruction inside a dispatch scope: the same Level paths the legacy Blueprint nodes take.Method set_activeSets active as part of the object model module.Method set_logical_parentSets logical parent as part of the object model module.Method set_nameSets name as part of the object model module.Method set_nameSets name as part of the object model module.Method set_wants_tickSets wants tick as part of the object model module.Method sha256_rotrPerforms `sha256 rotr` as part of the object model module.Function slotPerforms `slot` as part of the object model module.Method spawn_actorPerforms `spawn actor` as part of the object model module.Method spawn_batchAll or nothing.Method statePerforms `state` as part of the object model module.Method statsPerforms `stats` as part of the object model module.Method stopStops stop as part of the object model module.Method tickPerforms `tick` as part of the object model module.Method tickPerforms `tick` as part of the object model module.Method tick---- ticking -------------------------------------------------------------------Method timeline_syncRuntime hooks, not reflected.Method timeline_syncPerforms `timeline sync` as part of the object model module.Method validPerforms `valid` as part of the object model module.Method wants_tickPerforms `wants tick` as part of the object model module.Method

Fields, variables and values

acquireExposes `acquire` on `epok::ClassDescriptor` for the object model module.Field activeExposes `active` on `epok::ActorSpawnRequest` for the object model module.Field active_object_registryRegistry bound by the active Level.Variable actorExposes `actor` on `epok::LevelPendingOp` for the object model module.Field ActorNamed value `Actor` in `epok::ObjectFamily`.Enum value actor_component_capacityExposes `actor_component_capacity` on the `epok` namespace for the object model module.Variable alignExposes `align` on `epok::ClassDescriptor` for the object model module.Field aliveExposes `alive` on `epok::ObjectStats` for the object model module.Field attach_parentExposes `attach_parent` on `epok::NativeComponentDefault` for the object model module.Field attach_parentExposes `attach_parent` on `epok::RectTransformComponent` for the object model module.Field attach_parentExposes `attach_parent` on `epok::SceneComponent2D` for the object model module.Field attach_parentExposes `attach_parent` on `epok::SceneComponent3D` for the object model module.Field audio_source_retained---- service quarantine ------------------------------------------------------------ Some services retain the address of a component's storage across asynchronous callbacks.Variable capacityExposes `capacity` on `epok::ObjectPool` for the object model module.Variable capacityExposes `capacity` on `epok::ObjectRegistry` for the object model module.Field class_idExposes `class_id` on `epok::NativeComponentDefault` for the object model module.Field componentExposes `component` on `epok::NativeComponentDefault` for the object model module.Field ComponentNamed value `Component` in `epok::ObjectFamily`.Enum value createExposes `create` on `epok::ClassDescriptor` for the object model module.Field default_componentExposes `default_component` on `epok::ClassDescriptor` for the object model module.Field default_component_countExposes `default_component_count` on `epok::ClassDescriptor` for the object model module.Field deferredExposes `deferred` on `epok::ObjectStats` for the object model module.Field destroyExposes `destroy` on `epok::ClassDescriptor` for the object model module.Field destroyExposes `destroy` on `epok::LevelPendingOp` for the object model module.Field DestroyedNamed value `Destroyed` in `epok::EndPlayReason`.Enum value DestroyedNamed value `Destroyed` in `epok::ObjectState`.Enum value dispatchExposes `dispatch` on `epok::ObjectRegistry` for the object model module.Field domainExposes `domain` on `epok::ClassDescriptor` for the object model module.Field draw_orderExposes `draw_order` on `epok::Transform2D` for the object model module.Field EndingPlayNamed value `EndingPlay` in `epok::ObjectState`.Enum value familyExposes `family` on `epok::ClassDescriptor` for the object model module.Field flagsExposes `flags` on `epok::ClassDescriptor` for the object model module.Field generationExposes `generation` on `epok::ObjectId` for the object model module.Field generationExposes `generation` on `epok::ObjectSlot` for the object model module.Field handlesExposes `handles` on `epok::ObjectPool` for the object model module.Variable idExposes `id` on `epok::ClassDescriptor` for the object model module.Field indexExposes `index` on `epok::ObjectId` for the object model module.Field InitializedNamed value `Initialized` in `epok::ObjectState`.Enum value instanceExposes `instance` on `epok::ObjectSlot` for the object model module.Field levelService context.Field LevelNamed value `Level` in `epok::ObjectFamily`.Enum value level_actor_capacityExposes `level_actor_capacity` on the `epok` namespace for the object model module.Variable level_pending_capacityExposes `level_pending_capacity` on the `epok` namespace for the object model module.Variable LevelUnloadedNamed value `LevelUnloaded` in `epok::EndPlayReason`.Enum value localExposes `local` on `epok::AudioComponent` for the object model module.Field localExposes `local` on `epok::RectTransformComponent` for the object model module.Field localExposes `local` on `epok::SceneComponent3D` for the object model module.Field logical_parentExposes `logical_parent` on `epok::ActorSpawnRequest` for the object model module.Field nameExposes `name` on `epok::ActorSpawnRequest` for the object model module.Field nameExposes `name` on `epok::NativeComponentDefault` for the object model module.Field NoneNamed value `None` in `epok::ObjectDomain`.Enum value ObjectNamed value `Object` in `epok::ObjectFamily`.Enum value object_class_countExposes `object_class_count` on the `epok` namespace for the object model module.Variable object_classesEmitted by the Rust cook next to the scene banks.Variable object_hierarchy_depthExposes `object_hierarchy_depth` on the `epok` namespace for the object model module.Variable ObjectClassAbstractNamed value `ObjectClassAbstract` in `epok::ObjectClassFlags`.Enum value ObjectClassMultipleNamed value `ObjectClassMultiple` in `epok::ObjectClassFlags`.Enum value ObjectClassPlaceableNamed value `ObjectClassPlaceable` in `epok::ObjectClassFlags`.Enum value ObjectClassRootNamed value `ObjectClassRoot` in `epok::ObjectClassFlags`.Enum value ObjectClassSceneManagedNamed value `ObjectClassSceneManaged` in `epok::ObjectClassFlags`.Enum value ObjectClassSpawnableNamed value `ObjectClassSpawnable` in `epok::ObjectClassFlags`.Enum value owners_maskExposes `owners_mask` on `epok::ClassDescriptor` for the object model module.Field owns_storageExposes `owns_storage` on `epok::ObjectSlot` for the object model module.Field parentExposes `parent` on `epok::ClassDescriptor` for the object model module.Field peakExposes `peak` on `epok::ObjectStats` for the object model module.Field PlayingNamed value `Playing` in `epok::ObjectState`.Enum value positionExposes `position` on `epok::Transform2D` for the object model module.Field quarantinedExposes `quarantined` on `epok::ObjectStats` for the object model module.Field QuitNamed value `Quit` in `epok::EndPlayReason`.Enum value reasonExposes `reason` on `epok::LevelPendingOp` for the object model module.Field rectExposes `rect` on `epok::RectTransformComponent` for the object model module.Field registryExposes `registry` on `epok::ObjectDispatchScope` for the object model module.Field registryExposes `registry` on `epok::World` for the object model module.Field rejectedExposes `rejected` on `epok::ObjectStats` for the object model module.Field releaseExposes `release` on `epok::ClassDescriptor` for the object model module.Field releasingExposes `releasing` on `epok::ObjectSlot` for the object model module.Field requestExposes `request` on `epok::LevelPendingOp` for the object model module.Field ReservedNamed value `Reserved` in `epok::ObjectState`.Enum value rootExposes `root` on `epok::Actor2D` for the object model module.Field rootExposes `root` on `epok::Actor3D` for the object model module.Field rootExposes `root` on `epok::NativeComponentDefault` for the object model module.Field rootExposes `root` on `epok::UIActor` for the object model module.Field rotationExposes `rotation` on `epok::Transform2D` for the object model module.Field scaleExposes `scale` on `epok::Transform2D` for the object model module.Field sha256_kExposes `sha256_k` on the `epok::detail` namespace for the object model module.Variable sizeExposes `size` on `epok::ClassDescriptor` for the object model module.Field slotsExposes `slots` on `epok::ObjectRegistry` for the object model module.Field sourceExposes `source` on `epok::AudioComponent` for the object model module.Field spawnedExposes `spawned` on `epok::ObjectStats` for the object model module.Field stateExposes `state` on `epok::ObjectSlot` for the object model module.Field static_class_idExposes `static_class_id` on `epok::Actor` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::Actor2D` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::Actor3D` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::ActorComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::AudioComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::BlobShadowComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::Camera3DComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::CanvasComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::Collider3DComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::ImageComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::Level` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::Light3DComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::Mesh3DComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::Object` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::PaletteAnimatorComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::ParticleEffectComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::ParticleEmitterComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::ProgressBarComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::RectTransformComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::SceneComponent2D` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::SceneComponent3D` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::SceneScriptActor` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::Sprite3DComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::TextComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::TimelineComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::UIActor` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::UIComponent` for the object model module.Variable static_class_idExposes `static_class_id` on `epok::World` for the object model module.Variable statsExposes `stats` on `epok::ObjectRegistry` for the object model module.Field storage_bytesExposes `storage_bytes` on `epok::ObjectPool` for the object model module.Variable tableExposes `table` on `epok::ObjectRegistryStorage` for the object model module.Field transform2D actors own their transform: no legacy slot carries a Transform2D, and no fictitious 3D transform is created for them.Field transformView over the canonical slot transform when the owner is backed by a legacy entity.Field typeExposes `type` on `epok::ActorSpawnRequest` for the object model module.Field typeExposes `type` on `epok::ObjectSlot` for the object model module.Field UINamed value `UI` in `epok::ObjectDomain`.Enum value UnusedNamed value `Unused` in `epok::ObjectState`.Enum value usedExposes `used` on `epok::ObjectPool` for the object model module.Variable usedExposes `used` on `epok::ObjectSlot` for the object model module.Field valuesExposes `values` on `epok::ObjectPool` for the object model module.Variable WorldNamed value `World` in `epok::ObjectFamily`.Enum value World2DNamed value `World2D` in `epok::ObjectDomain`.Enum value World3DNamed value `World3D` in `epok::ObjectDomain`.Enum value