|
| RenderMeshDrawable (Context *context) |
| Construct.
|
|
void | UpdateBatches (const FrameInfo &frame) override |
|
| StaticModel (Context *context) |
| Construct.
|
|
| ~StaticModel () override |
| Destruct.
|
|
void | ProcessCustomRayQuery (const RayOctreeQuery &query, const BoundingBox &worldBoundingBox, const Matrix3x4 &worldTransform, ea::vector< RayQueryResult > &results) |
| Process raycast with custom transform.
|
|
void | ProcessRayQuery (const RayOctreeQuery &query, ea::vector< RayQueryResult > &results) override |
| Process octree raycast. May be called from a worker thread.
|
|
void | UpdateBatches (const FrameInfo &frame) override |
| Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly.
|
|
Geometry * | GetLodGeometry (unsigned batchIndex, unsigned level) override |
| Return the geometry for a specific LOD level.
|
|
unsigned | GetNumOccluderTriangles () override |
| Return number of occlusion geometry triangles.
|
|
bool | DrawOcclusion (OcclusionBuffer *buffer) override |
| Draw to occlusion buffer. Return true if did not run out of triangles.
|
|
virtual void | SetModel (Model *model) |
|
virtual void | SetMaterial (Material *material) |
|
virtual bool | SetMaterial (unsigned index, Material *material) |
|
void | SetOcclusionLodLevel (unsigned level) |
|
void | ApplyMaterialList (const ea::string &fileName=EMPTY_STRING) |
| Apply default materials from a material list file. If filename is empty (default), the model's resource name with extension .txt will be used.
|
|
void | SetBoundingBox (const BoundingBox &box) |
|
void | ResetLodLevels () |
| Reset cached LOD levels and associated geometries.
|
|
Model * | GetModel () const |
|
unsigned | GetNumGeometries () const |
|
virtual Material * | GetMaterial () const |
|
virtual Material * | GetMaterial (unsigned index) const |
|
unsigned | GetOcclusionLodLevel () const |
|
bool | IsInside (const Vector3 &point) const |
| Determines if the given world space point is within the model geometry.
|
|
bool | IsInsideLocal (const Vector3 &point) const |
| Determines if the given local space point is within the model geometry.
|
|
void | SetModelAttr (const ResourceRef &value) |
| Set model attribute.
|
|
void | SetMaterialsAttr (const ResourceRefList &value) |
| Set materials attribute.
|
|
ResourceRef | GetModelAttr () const |
| Return model attribute.
|
|
const ResourceRefList & | GetMaterialsAttr () const |
| Return materials attribute.
|
|
void | SetBakeLightmap (bool bakeLightmap) |
| Set whether the lightmap is baked for this object.
|
|
bool | GetBakeLightmap () const |
| Return whether the lightmap is baked for this object.
|
|
bool | GetBakeLightmapEffective () const |
| Return whether the lightmap is baked for this object. Return false for objects with zero scale in lightmap.
|
|
void | SetScaleInLightmap (float scale) |
| Set scale in lightmap.
|
|
float | GetScaleInLightmap () const |
| Return scale in lightmap.
|
|
void | SetLightmapIndex (unsigned idx) |
| Set lightmap index.
|
|
unsigned | GetLightmapIndex () const |
| Return lightmap index.
|
|
void | SetLightmapScaleOffset (const Vector4 &scaleOffset) |
| Set lightmap scale and offset.
|
|
const Vector4 & | GetLightmapScaleOffset () const |
| Return lightmap scale and offset.
|
|
| Drawable (Context *context, DrawableFlags drawableFlags=DRAWABLE_UNDEFINED) |
| Construct.
|
|
| ~Drawable () override |
| Destruct.
|
|
void | OnSetEnabled () override |
| Handle enabled/disabled state change.
|
|
void | ProcessCustomRayQuery (const RayOctreeQuery &query, const BoundingBox &worldBoundingBox, ea::vector< RayQueryResult > &results) |
| Process raycast with custom transform.
|
|
virtual void | Update (const FrameInfo &frame) |
| Update before octree reinsertion. Is called from a worker thread.
|
|
virtual void | UpdateBatchesDelayed (const FrameInfo &frame) |
| Batch update from main thread. Called on demand only if RequestUpdateBatchesDelayed() is called from UpdateBatches().
|
|
virtual void | UpdateGeometry (const FrameInfo &frame) |
| Prepare geometry for rendering.
|
|
virtual UpdateGeometryType | GetUpdateGeometryType () |
| Return whether a geometry update is necessary, and if it can happen in a worker thread.
|
|
void | DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override |
| Visualize the component as debug geometry.
|
|
void | SetDrawDistance (float distance) |
|
void | SetShadowDistance (float distance) |
|
void | SetLodBias (float bias) |
|
void | SetViewMask (unsigned mask) |
|
void | SetLightMask (unsigned mask) |
|
void | SetShadowMask (unsigned mask) |
|
void | SetZoneMask (unsigned mask) |
|
void | SetCastShadows (bool enable) |
|
void | SetOccluder (bool enable) |
|
void | SetOccludee (bool enable) |
|
void | SetGlobalIlluminationType (GlobalIlluminationType type) |
| Set GI type.
|
|
void | SetReflectionMode (ReflectionMode mode) |
| Set reflection mode.
|
|
void | MarkForUpdate () |
| Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
|
|
const BoundingBox & | GetBoundingBox () const |
|
const BoundingBox & | GetWorldBoundingBox () |
|
DrawableFlags | GetDrawableFlags () const |
| Return drawable flags.
|
|
float | GetDrawDistance () const |
|
float | GetShadowDistance () const |
|
float | GetLodBias () const |
|
unsigned | GetViewMask () const |
|
unsigned | GetLightMask () const |
|
unsigned | GetShadowMask () const |
|
unsigned | GetZoneMask () const |
|
bool | GetCastShadows () const |
|
bool | IsOccluder () const |
|
bool | IsOccludee () const |
|
GlobalIlluminationType | GetGlobalIlluminationType () const |
| Return global illumination type.
|
|
ReflectionMode | GetReflectionMode () const |
| Return reflection mode.
|
|
bool | IsInView () const |
|
bool | IsInView (Camera *camera) const |
| Return whether is in view of a specific camera this frame. Pass in a null camera to allow any camera, including shadow map cameras.
|
|
const ea::vector< SourceBatch > & | GetBatches () const |
| Return draw call source data.
|
|
void | SetZone (Zone *zone, bool temporary=false) |
| Set new zone. Zone assignment may optionally be temporary, meaning it needs to be re-evaluated on the next frame.
|
|
void | SetSortValue (float value) |
| Set sorting value.
|
|
void | MarkInView (const FrameInfo &frame) |
| Mark in view. Also clear the light list.
|
|
void | MarkInView (unsigned frameNumber) |
| Mark in view without specifying a camera. Used for shadow casters.
|
|
Octant * | GetOctant () const |
| Return octree octant.
|
|
unsigned | GetDrawableIndex () const |
| Return index in octree.
|
|
bool | IsInOctree () const |
| Return whether the drawable is added to Octree.
|
|
Zone * | GetZone () const |
|
bool | IsZoneDirty () const |
| Return whether current zone is inconclusive or dirty due to the drawable moving.
|
|
float | GetDistance () const |
| Return distance from camera.
|
|
float | GetLodDistance () const |
| Return LOD scaled distance from camera.
|
|
float | GetSortValue () const |
| Return sorting value.
|
|
bool | IsInView (const FrameInfo &frame, bool anyCamera=false) const |
| Return whether is in view on the current frame. Called by View.
|
|
unsigned & | GetMutableLightProbeTetrahedronHint () |
| Return mutable light probe tetrahedron hint.
|
|
CachedDrawableZone & | GetMutableCachedZone () |
| Return mutable cached zone data.
|
|
CachedDrawableReflection & | GetMutableCachedReflection () |
| Return mutable cached reflection data.
|
|
unsigned | GetLightMaskInZone () const |
| Return combined light masks of Drawable and its currently cached Zone.
|
|
unsigned | GetShadowMaskInZone () const |
| Return combined shadow masks of Drawable and its currently cached Zone.
|
|
| Component (Context *context) |
| Construct.
|
|
| ~Component () override |
| Destruct.
|
|
AttributeScopeHint | GetEffectiveScopeHint () const |
|
bool | Save (Serializer &dest) const override |
| Save as binary data. Return true if successful.
|
|
bool | SaveXML (XMLElement &dest) const override |
| Save as XML data. Return true if successful.
|
|
bool | SaveJSON (JSONValue &dest) const override |
| Save as JSON data. Return true if successful.
|
|
virtual void | GetDependencyNodes (ea::vector< Node * > &dest) |
| Return the depended on nodes to order network updates.
|
|
virtual bool | HasAuxiliaryData () const |
|
virtual void | SerializeAuxiliaryData (Archive &archive) |
| Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException.
|
|
void | SetEnabled (bool enable) |
|
void | Remove () |
| Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
|
|
unsigned | GetID () const |
|
Node * | GetNode () const |
|
Scene * | GetScene () const |
| Return the scene the node belongs to.
|
|
bool | IsEnabled () const |
|
bool | IsEnabledEffective () const |
|
ea::string | GetFullNameDebug () const |
| Return full component name for debugging. Unique for each component in the scene. Slow!
|
|
Component * | GetComponent (StringHash type) const |
| Return component in the same scene node by type. If there are several, returns the first.
|
|
template<class T > |
T * | GetComponent () const |
| Template version of returning a component in the same scene node by type.
|
|
unsigned | GetIndexInParent () const |
| Return index of this component in the node.
|
|
| Serializable (Context *context) |
| Construct.
|
|
| ~Serializable () override |
| Destruct.
|
|
virtual void | OnSetAttribute (const AttributeInfo &attr, const Variant &src) |
| Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
|
|
virtual void | OnGetAttribute (const AttributeInfo &attr, Variant &dest) const |
| Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
|
|
virtual ObjectReflection * | GetReflection () const |
| Return reflection used for serialization.
|
|
virtual const ea::vector< AttributeInfo > * | GetAttributes () const |
| Return attribute descriptions, or null if none defined.
|
|
void | SerializeInBlock (Archive &archive) override |
| Serialize content from/to archive. May throw ArchiveException.
|
|
void | SerializeInBlock (Archive &archive, bool serializeTemporary) |
|
virtual bool | Load (Deserializer &source) |
| Load from binary data. Return true if successful.
|
|
virtual bool | LoadXML (const XMLElement &source) |
| Load from XML data. Return true if successful.
|
|
virtual bool | LoadJSON (const JSONValue &source) |
| Load from JSON data. Return true if successful.
|
|
virtual bool | Load (const ea::string &resourceName) |
| Load from binary resource.
|
|
virtual bool | LoadXML (const ea::string &resourceName) |
| Load from XML resource.
|
|
virtual bool | LoadJSON (const ea::string &resourceName) |
| Load from JSON resource.
|
|
virtual bool | LoadFile (const ea::string &resourceName) |
| Load from resource of automatically detected type.
|
|
virtual void | ApplyAttributes () |
| Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
|
|
virtual bool | SaveDefaultAttributes (const AttributeInfo &attr) const |
| Return whether should save default-valued attributes into XML. Default false.
|
|
bool | SetAttribute (unsigned index, const Variant &value) |
|
bool | SetAttribute (const ea::string &name, const Variant &value) |
| Set attribute by name. Return true if successfully set.
|
|
void | SetInstanceDefault (bool enable) |
| (Internal use) Set instance-level default flag.
|
|
void | SetInstanceDefault (const ea::string &name, const Variant &defaultValue) |
| (Internal use) Set instance-level default value. Allocate the internal data structure as necessary.
|
|
virtual Variant | GetInstanceDefault (const ea::string &name) const |
| (Internal use) Get instance-level default value.
|
|
void | ResetToDefault () |
| Reset all editable attributes to their default values.
|
|
void | RemoveInstanceDefault () |
| Remove instance's default values if they are set previously.
|
|
void | SetTemporary (bool enable) |
|
Variant | GetAttribute (unsigned index) const |
|
Variant | GetAttribute (const ea::string &name) const |
| Return attribute value by name. Return empty if not found.
|
|
Variant | GetAttributeDefault (unsigned index) const |
|
Variant | GetAttributeDefault (const ea::string &name) const |
| Return attribute default value by name. Return empty if not found.
|
|
unsigned | GetNumAttributes () const |
|
void | CopyAttributes (const Serializable *source, bool resetToDefault=true) |
| Copy all attributes from another serializable.
|
|
SharedPtr< Serializable > | Clone (bool resetToDefault=true) const |
| Clone this serializable.
|
|
bool | IsTemporary () const |
|
| Object (Context *context) |
| Construct.
|
|
| ~Object () override |
| Destruct. Clean up self from event sender & receiver structures.
|
|
virtual StringHash | GetType () const =0 |
|
virtual const ea::string & | GetTypeName () const =0 |
|
virtual const TypeInfo * | GetTypeInfo () const =0 |
| Return type info.
|
|
virtual bool | IsInstanceOf (StringHash type) const =0 |
| Check whether current instance implements specified type.
|
|
virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event.
|
|
template<typename T > |
bool | IsInstanceOf () const |
| Check current instance is type of specified class.
|
|
template<typename T > |
T * | Cast () |
| Cast the object to specified most derived class.
|
|
template<typename T > |
const T * | Cast () const |
| Cast the object to specified most derived class.
|
|
void | SubscribeToEventManual (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender.
|
|
void | SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event.
|
|
template<class T > |
void | SubscribeToEvent (StringHash eventType, T handler) |
| Subscribe to an event that can be sent by any sender.
|
|
template<class T > |
void | SubscribeToEvent (Object *sender, StringHash eventType, T handler) |
| Subscribe to a specific sender's event.
|
|
void | UnsubscribeFromEvent (StringHash eventType) |
| Unsubscribe from an event.
|
|
void | UnsubscribeFromEvent (Object *sender, StringHash eventType) |
| Unsubscribe from a specific sender's event.
|
|
void | UnsubscribeFromEvents (Object *sender) |
| Unsubscribe from a specific sender's events.
|
|
void | UnsubscribeFromAllEvents () |
| Unsubscribe from all events.
|
|
void | UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions) |
| Unsubscribe from all events except those listed.
|
|
void | UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions) |
| Unsubscribe from all events except those with listed senders.
|
|
void | SendEvent (StringHash eventType) |
| Send event to all subscribers.
|
|
void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers.
|
|
VariantMap & | GetEventDataMap () const |
| Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
|
|
template<typename... Args> |
void | SendEvent (StringHash eventType, const Args &... args) |
| Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
|
|
Context * | GetContext () const |
| Return execution context.
|
|
const Variant & | GetGlobalVar (StringHash key) const |
|
const VariantMap & | GetGlobalVars () const |
|
void | SetGlobalVar (StringHash key, const Variant &value) |
|
Object * | GetSubsystem (StringHash type) const |
| Return subsystem by type.
|
|
Object * | GetEventSender () const |
| Return active event sender. Null outside event handling.
|
|
EventHandler * | GetEventHandler () const |
| Return active event handler. Null outside event handling.
|
|
bool | HasSubscribedToEvent (StringHash eventType) const |
| Return whether has subscribed to an event without specific sender.
|
|
bool | HasSubscribedToEvent (Object *sender, StringHash eventType) const |
| Return whether has subscribed to a specific sender's event.
|
|
bool | HasEventHandlers () const |
| Return whether has subscribed to any event.
|
|
template<class T > |
T * | GetSubsystem () const |
| Template version of returning a subsystem.
|
|
const ea::string & | GetCategory () const |
|
void | SendEvent (StringHash eventType, const VariantMap &eventData) |
| Send event with parameters to all subscribers.
|
|
void | SetBlockEvents (bool block) |
| Block object from sending and receiving events.
|
|
bool | GetBlockEvents () const |
| Return sending and receiving events blocking status.
|
|
| RefCounted () |
| Construct. Allocate the reference count structure and set an initial self weak reference.
|
|
virtual | ~RefCounted () |
| Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
|
|
| RefCounted (const RefCounted &rhs)=delete |
| Prevent copy construction.
|
|
RefCounted & | operator= (const RefCounted &rhs)=delete |
| Prevent assignment.
|
|
int | AddRef () |
|
int | ReleaseRef () |
|
int | Refs () const |
|
int | WeakRefs () const |
|
RefCount * | RefCountPtr () const |
| Return pointer to the reference count structure.
|
|
bool | HasScriptObject () const |
| Return true if script runtime object wrapping this native object exists.
|
|
bool | IsScriptStrongRef () const |
| Return true if script reference is strong.
|
|
virtual | ~PipelineStateTracker () |
| Destruct.
|
|
unsigned | GetPipelineStateHash () const |
| Return (partial) pipeline state hash. Save to call from multiple threads as long as the object is not changing.
|
|
void | MarkPipelineStateHashDirty () |
| Mark pipeline state hash as dirty.
|
|
|
static void | RegisterObject (Context *context) |
|
static void | RegisterObject (Context *context) |
|
static const TypeInfo * | GetTypeInfoStatic () |
| Return type info static.
|
|
static constexpr ea::array< StringHash, 0 > | TypeHierarchy {} |
|
void | OnWorldBoundingBoxUpdate () override |
| Recalculate the world-space bounding box.
|
|
void | SetNumGeometries (unsigned num) |
| Set number of geometries.
|
|
void | CalculateLodLevels () |
| Choose LOD levels based on distance.
|
|
void | UpdateBatchesLightmaps () |
| Update lightmaps in batches.
|
|
unsigned | RecalculatePipelineStateHash () const override |
| Recalculate hash. Shall be save to call from multiple threads as long as the object is not changing.
|
|
void | OnNodeSet (Node *previousNode, Node *currentNode) override |
| Handle node being assigned.
|
|
void | OnSceneSet (Scene *previousScene, Scene *scene) override |
| Handle scene being assigned.
|
|
void | OnMarkedDirty (Node *node) override |
| Handle node transform being dirtied.
|
|
virtual void | OnRemoveFromOctree () |
| Handle removal from octree.
|
|
void | AddToOctree () |
| Add to octree.
|
|
void | RemoveFromOctree () |
| Remove from octree.
|
|
void | RequestUpdateBatchesDelayed (const FrameInfo &frame) |
| Request UpdateBatchesDelayed call from main thread.
|
|
void | SetOctant (Octant *octant) |
| Move into another octree octant.
|
|
void | SetDrawableIndex (unsigned drawableIndex) |
| Update drawable index.
|
|
virtual void | OnNodeSetEnabled (Node *node) |
| Handle scene node enabled status changing.
|
|
void | SetID (unsigned id) |
|
void | SetNode (Node *node) |
| Set scene node. Called by Node when creating the component.
|
|
Component * | GetFixedUpdateSource () |
| Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
|
|
void | DoAutoRemove (AutoRemoveMode mode) |
| Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.
|
|
PipelineStateSubscription | CreateDependency (PipelineStateTracker *dependency) |
| Create dependency onto another pipeline state.
|
|
void | AddSubscriberReference (PipelineStateTracker *subscriber) |
| Add reference to subscriber pipeline state tracker.
|
|
void | RemoveSubscriberReference (PipelineStateTracker *subscriber) |
| Remove reference to subscriber pipeline state tracker.
|
|
static Geometry * | GetGeometryIfNotEmpty (Geometry *geometry) |
| Get Geometry pointer if the source one is not null or empty.
|
|
ea::vector< StaticModelGeometryData > | geometryData_ |
| Extra per-geometry data.
|
|
ea::vector< ea::vector< SharedPtr< Geometry > > > | geometries_ |
| All geometries.
|
|
SharedPtr< Model > | model_ |
| Model.
|
|
unsigned | occlusionLodLevel_ |
| Occlusion LOD level.
|
|
ResourceRefList | materialsAttr_ |
| Material list attribute.
|
|
bool | bakeLightmap_ {} |
| Whether the lightmap is enabled.
|
|
float | scaleInLightmap_ { 1.0f } |
| Texel density scale in lightmap.
|
|
unsigned | lightmapIndex_ {} |
| Lightmap index.
|
|
Vector4 | lightmapScaleOffset_ { 1.0f, 1.0f, 0.0f, 0.0f } |
| Lightmap scale and offset.
|
|
BoundingBox | worldBoundingBox_ |
| World-space bounding box.
|
|
BoundingBox | boundingBox_ |
| Local-space bounding box.
|
|
ea::vector< SourceBatch > | batches_ |
| Draw call source data.
|
|
DrawableFlags | drawableFlags_ |
| Drawable flags.
|
|
GlobalIlluminationType | giType_ {} |
| Global illumination type.
|
|
ReflectionMode | reflectionMode_ {ReflectionMode::BlendProbesAndZone} |
| Reflection mode.
|
|
bool | worldBoundingBoxDirty_ |
| Bounding box dirty flag.
|
|
bool | castShadows_ |
| Shadowcaster flag.
|
|
bool | occluder_ |
| Occluder flag.
|
|
bool | occludee_ |
| Occludee flag.
|
|
bool | updateQueued_ |
| Octree update queued flag.
|
|
bool | zoneDirty_ |
| Zone inconclusive or dirtied flag.
|
|
Octant * | octant_ |
| Octree octant.
|
|
unsigned | drawableIndex_ { M_MAX_UNSIGNED } |
| Index of Drawable in Scene. May be updated.
|
|
CachedDrawableZone | cachedZone_ |
| Current zone.
|
|
CachedDrawableReflection | cachedReflection_ |
| Current reflection.
|
|
unsigned | viewMask_ |
| View mask.
|
|
unsigned | lightMask_ |
| Light mask.
|
|
unsigned | shadowMask_ |
| Shadow mask.
|
|
unsigned | zoneMask_ |
| Zone mask.
|
|
unsigned | viewFrameNumber_ |
| Last visible frame number.
|
|
float | distance_ |
| Current distance to camera.
|
|
float | lodDistance_ |
| LOD scaled distance.
|
|
float | drawDistance_ |
| Draw distance.
|
|
float | shadowDistance_ |
| Shadow distance.
|
|
float | sortValue_ |
| Current sort value.
|
|
float | lodBias_ |
| LOD bias.
|
|
unsigned | lightProbeTetrahedronHint_ { M_MAX_UNSIGNED } |
| Light probe tetrahedron hint.
|
|
ea::vector< Camera * > | viewCameras_ |
| List of cameras from which is seen on the current frame.
|
|
Node * | node_ |
| Scene node.
|
|
unsigned | id_ |
| Unique ID within the scene.
|
|
bool | networkUpdate_ |
| Network update queued flag.
|
|
bool | enabled_ |
| Enabled flag.
|
|
ea::unique_ptr< VariantMap > | instanceDefaultValues_ |
| Attribute default value at each instance level.
|
|
bool | setInstanceDefault_ |
| When true, store the attribute value as instance's default value (internal use only).
|
|
bool | temporary_ |
| Temporary flag.
|
|
WeakPtr< Context > | context_ |
| Execution context.
|
|