|
| ParticleEmitter (Context *context) |
| Construct.
|
|
| ~ParticleEmitter () override |
| Destruct.
|
|
void | OnSetEnabled () override |
| Handle enabled/disabled state change.
|
|
void | Update (const FrameInfo &frame) override |
| Update before octree reinsertion. Is called from a worker thread.
|
|
void | SetEffect (ParticleEffect *effect) |
| Set particle effect.
|
|
void | SetNumParticles (unsigned num) |
| Set maximum number of particles.
|
|
void | SetEmitting (bool enable) |
| Set whether should be emitting. If the state was changed, also resets the emission period timer.
|
|
void | SetSerializeParticles (bool enable) |
| Set whether particles should be serialized. Default true, set false to reduce scene file size.
|
|
void | SetAutoRemoveMode (AutoRemoveMode mode) |
|
void | ResetEmissionTimer () |
| Reset the emission period timer.
|
|
void | RemoveAllParticles () |
| Remove all current particles.
|
|
void | Reset () |
| Reset the particle emitter completely. Removes current particles, sets emitting state on, and resets the emission timer.
|
|
void | ApplyEffect () |
| Apply not continuously updated values such as the material, the number of particles and sorting mode from the particle effect. Call this if you change the effect programmatically.
|
|
ParticleEffect * | GetEffect () const |
| Return particle effect.
|
|
unsigned | GetNumParticles () const |
| Return maximum number of particles.
|
|
bool | IsEmitting () const |
| Return whether is currently emitting.
|
|
bool | GetSerializeParticles () const |
| Return whether particles are to be serialized.
|
|
AutoRemoveMode | GetAutoRemoveMode () const |
| Return automatic removal mode on particle effect completion.
|
|
void | SetEffectAttr (const ResourceRef &value) |
| Set particles effect attribute.
|
|
ResourceRef | GetEffectAttr () const |
| Set particles effect attribute.
|
|
void | SetParticlesAttr (const VariantVector &value) |
| Set particles attribute.
|
|
VariantVector | GetParticlesAttr () const |
| Return particles attribute. Returns particle amount only if particles are not to be serialized.
|
|
VariantVector | GetParticleBillboardsAttr () const |
| Return billboards attribute. Returns billboard amount only if particles are not to be serialized.
|
|
| BillboardSet (Context *context) |
| Construct.
|
|
| ~BillboardSet () override |
| Destruct.
|
|
void | ProcessRayQuery (const RayOctreeQuery &query, PODVector< 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.
|
|
void | UpdateGeometry (const FrameInfo &frame) override |
| Prepare geometry for rendering. Called from a worker thread if possible (no GPU update.)
|
|
UpdateGeometryType | GetUpdateGeometryType () override |
| Return whether a geometry update is necessary, and if it can happen in a worker thread.
|
|
void | SetMaterial (Material *material) |
| Set material.
|
|
void | SetNumBillboards (unsigned num) |
| Set number of billboards.
|
|
void | SetRelative (bool enable) |
| Set whether billboards are relative to the scene node. Default true.
|
|
void | SetScaled (bool enable) |
| Set whether scene node scale affects billboards' size. Default true.
|
|
void | SetSorted (bool enable) |
| Set whether billboards are sorted by distance. Default false.
|
|
void | SetFixedScreenSize (bool enable) |
| Set whether billboards have fixed size on screen (measured in pixels) regardless of distance to camera. Default false.
|
|
void | SetFaceCameraMode (FaceCameraMode mode) |
| Set how the billboards should rotate in relation to the camera. Default is to follow camera rotation on all axes (FC_ROTATE_XYZ.)
|
|
void | SetMinAngle (float angle) |
| Set minimal angle between billboard normal and look-at direction.
|
|
void | SetAnimationLodBias (float bias) |
| Set animation LOD bias.
|
|
void | Commit () |
| Mark for bounding box and vertex buffer update. Call after modifying the billboards.
|
|
Material * | GetMaterial () const |
| Return material.
|
|
unsigned | GetNumBillboards () const |
| Return number of billboards.
|
|
PODVector< Billboard > & | GetBillboards () |
| Return all billboards.
|
|
Billboard * | GetBillboard (unsigned index) |
| Return billboard by index.
|
|
bool | IsRelative () const |
| Return whether billboards are relative to the scene node.
|
|
bool | IsScaled () const |
| Return whether scene node scale affects billboards' size.
|
|
bool | IsSorted () const |
| Return whether billboards are sorted.
|
|
bool | IsFixedScreenSize () const |
| Return whether billboards are fixed screen size.
|
|
FaceCameraMode | GetFaceCameraMode () const |
| Return how the billboards rotate in relation to the camera.
|
|
float | GetMinAngle () const |
| Return minimal angle between billboard normal and look-at direction.
|
|
float | GetAnimationLodBias () const |
| Return animation LOD bias.
|
|
void | SetMaterialAttr (const ResourceRef &value) |
| Set material attribute.
|
|
void | SetBillboardsAttr (const VariantVector &value) |
| Set billboards attribute.
|
|
void | SetNetBillboardsAttr (const PODVector< unsigned char > &value) |
| Set billboards attribute for network replication.
|
|
ResourceRef | GetMaterialAttr () const |
| Return material attribute.
|
|
VariantVector | GetBillboardsAttr () const |
| Return billboards attribute.
|
|
const PODVector< unsigned char > & | GetNetBillboardsAttr () const |
| Return billboards attribute for network replication.
|
|
| Drawable (Context *context, unsigned char drawableFlags) |
| Construct.
|
|
| ~Drawable () override |
| Destruct.
|
|
virtual bool | DrawOcclusion (OcclusionBuffer *buffer) |
| Draw to occlusion buffer. Return true if did not run out of triangles.
|
|
void | DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override |
| Visualize the component as debug geometry.
|
|
virtual Geometry * | GetLodGeometry (unsigned batchIndex, unsigned level) |
| Return the geometry for a specific LOD level.
|
|
virtual unsigned | GetNumOccluderTriangles () |
| Return number of occlusion geometry triangles.
|
|
void | SetDrawDistance (float distance) |
| Set draw distance.
|
|
void | SetShadowDistance (float distance) |
| Set shadow draw distance.
|
|
void | SetLodBias (float bias) |
| Set LOD bias.
|
|
void | SetViewMask (unsigned mask) |
| Set view mask. Is and'ed with camera's view mask to see if the object should be rendered.
|
|
void | SetLightMask (unsigned mask) |
| Set light mask. Is and'ed with light's and zone's light mask to see if the object should be lit.
|
|
void | SetShadowMask (unsigned mask) |
| Set shadow mask. Is and'ed with light's light mask and zone's shadow mask to see if the object should be rendered to a shadow map.
|
|
void | SetZoneMask (unsigned mask) |
| Set zone mask. Is and'ed with zone's zone mask to see if the object should belong to the zone.
|
|
void | SetMaxLights (unsigned num) |
| Set maximum number of per-pixel lights. Default 0 is unlimited.
|
|
void | SetCastShadows (bool enable) |
| Set shadowcaster flag.
|
|
void | SetOccluder (bool enable) |
| Set occlusion flag.
|
|
void | SetOccludee (bool enable) |
| Set occludee flag.
|
|
void | MarkForUpdate () |
| Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
|
|
void | AddLight (Light *light) |
| Add a per-pixel light affecting the object this frame.
|
|
void | AddVertexLight (Light *light) |
| Add a per-vertex light affecting the object this frame.
|
|
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 | SetBasePass (unsigned batchIndex) |
| Set base pass flag for a batch.
|
|
void | SetSortValue (float value) |
| Set sorting value.
|
|
void | SetMinMaxZ (float minZ, float maxZ) |
| Set view-space depth bounds.
|
|
const BoundingBox & | GetBoundingBox () const |
| Return local space bounding box. May not be applicable or properly updated on all drawables.
|
|
const BoundingBox & | GetWorldBoundingBox () |
| Return world-space bounding box.
|
|
unsigned char | GetDrawableFlags () const |
| Return drawable flags.
|
|
float | GetDrawDistance () const |
| Return draw distance.
|
|
float | GetShadowDistance () const |
| Return shadow draw distance.
|
|
float | GetLodBias () const |
| Return LOD bias.
|
|
unsigned | GetViewMask () const |
| Return view mask.
|
|
unsigned | GetLightMask () const |
| Return light mask.
|
|
unsigned | GetShadowMask () const |
| Return shadow mask.
|
|
unsigned | GetZoneMask () const |
| Return zone mask.
|
|
unsigned | GetMaxLights () const |
| Return maximum number of per-pixel lights.
|
|
bool | GetCastShadows () const |
| Return shadowcaster flag.
|
|
bool | IsOccluder () const |
| Return occluder flag.
|
|
bool | IsOccludee () const |
| Return occludee flag.
|
|
bool | IsInView () const |
| Return whether is in view this frame from any viewport camera. Excludes shadow map cameras.
|
|
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 Vector< SourceBatch > & | GetBatches () const |
| Return draw call source data.
|
|
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.
|
|
void | LimitLights () |
| Sort and limit per-pixel lights to maximum allowed. Convert extra lights into vertex lights.
|
|
void | LimitVertexLights (bool removeConvertedLights) |
| Sort and limit per-vertex lights to maximum allowed.
|
|
Octant * | GetOctant () const |
| Return octree octant.
|
|
Zone * | GetZone () const |
| Return current zone.
|
|
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.
|
|
bool | HasBasePass (unsigned batchIndex) const |
| Return whether has a base pass.
|
|
const PODVector< Light * > & | GetLights () const |
| Return per-pixel lights.
|
|
const PODVector< Light * > & | GetVertexLights () const |
| Return per-vertex lights.
|
|
Light * | GetFirstLight () const |
| Return the first added per-pixel light.
|
|
float | GetMinZ () const |
| Return the minimum view-space depth.
|
|
float | GetMaxZ () const |
| Return the maximum view-space depth.
|
|
| Component (Context *context) |
| Construct.
|
|
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.
|
|
void | MarkNetworkUpdate () override |
| Mark for attribute check on the next network update.
|
|
virtual void | GetDependencyNodes (PODVector< Node *> &dest) |
| Return the depended on nodes to order network updates.
|
|
void | SetEnabled (bool enable) |
| Set enabled/disabled state.
|
|
void | Remove () |
| Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
|
|
unsigned | GetID () const |
| Return ID.
|
|
bool | IsReplicated () const |
| Return whether the component is replicated or local to a scene.
|
|
bool | IsEnabled () const |
| Return whether is enabled.
|
|
bool | IsEnabledEffective () const |
| Return whether is effectively enabled (node is also enabled).
|
|
Node * | GetNode () const |
| Return scene node.
|
|
Scene * | GetScene () const |
| Return the scene the node belongs to.
|
|
Component * | GetComponent (StringHash type) const |
| Return component in the same scene node by first of type.
|
|
void | GetComponents (PODVector< Component *> &dest, StringHash type) const |
| Return components in the same scene node by type.
|
|
template<class T > |
T * | GetComponent () const |
| Template version of returning component in the same scene node by first of type.
|
|
template<class T > |
void | GetComponents (PODVector< T *> &dest) const |
| Template version of returning components in the same scene node by type.
|
|
void | AddReplicationState (ComponentReplicationState *state) |
| Add a replication state that is tracking this component.
|
|
void | PrepareNetworkUpdate () |
| Prepare network update by comparing attributes and marking replication states dirty as necessary.
|
|
void | CleanupConnection (Connection *connection) |
| Clean up all references to a network connection that is about to be removed.
|
|
| Animatable (Context *context) |
| Construct.
|
|
| ~Animatable () override |
| Destruct.
|
|
bool | LoadXML (const XMLElement &source) override |
| Load from XML data. Return true if successful.
|
|
bool | LoadJSON (const JSONValue &source) override |
| Load from JSON data. Return true if successful.
|
|
void | SetAnimationEnabled (bool enable) |
| Set automatic update of animation, default true.
|
|
void | SetAnimationTime (float time) |
| Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case.
|
|
void | SetObjectAnimation (ObjectAnimation *objectAnimation) |
| Set object animation.
|
|
void | SetAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f) |
| Set attribute animation.
|
|
void | SetAttributeAnimationWrapMode (const String &name, WrapMode wrapMode) |
| Set attribute animation wrap mode.
|
|
void | SetAttributeAnimationSpeed (const String &name, float speed) |
| Set attribute animation speed.
|
|
void | SetAttributeAnimationTime (const String &name, float time) |
| Set attribute animation time position manually. Automatic update should be disabled in this case.
|
|
void | RemoveObjectAnimation () |
| Remove object animation. Same as calling SetObjectAnimation with a null pointer.
|
|
void | RemoveAttributeAnimation (const String &name) |
| Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer.
|
|
bool | GetAnimationEnabled () const |
| Return animation enabled.
|
|
ObjectAnimation * | GetObjectAnimation () const |
| Return object animation.
|
|
ValueAnimation * | GetAttributeAnimation (const String &name) const |
| Return attribute animation.
|
|
WrapMode | GetAttributeAnimationWrapMode (const String &name) const |
| Return attribute animation wrap mode.
|
|
float | GetAttributeAnimationSpeed (const String &name) const |
| Return attribute animation speed.
|
|
float | GetAttributeAnimationTime (const String &name) const |
| Return attribute animation time position.
|
|
void | SetObjectAnimationAttr (const ResourceRef &value) |
| Set object animation attribute.
|
|
ResourceRef | GetObjectAnimationAttr () const |
| Return object animation attribute.
|
|
| 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 const Vector< AttributeInfo > * | GetAttributes () const |
| Return attribute descriptions, or null if none defined.
|
|
virtual const Vector< AttributeInfo > * | GetNetworkAttributes () const |
| Return network replication attribute descriptions, or null if none defined.
|
|
virtual bool | Load (Deserializer &source) |
| Load from binary data. Return true if successful.
|
|
virtual void | ApplyAttributes () |
| Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
|
|
virtual bool | SaveDefaultAttributes () const |
| Return whether should save default-valued attributes into XML. Default false.
|
|
bool | SetAttribute (unsigned index, const Variant &value) |
| Set attribute by index. Return true if successfully set.
|
|
bool | SetAttribute (const String &name, const Variant &value) |
| Set attribute by name. Return true if successfully set.
|
|
void | SetInstanceDefault (bool enable) |
| Set instance-level default flag.
|
|
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) |
| Set temporary flag. Temporary objects will not be saved.
|
|
void | SetInterceptNetworkUpdate (const String &attributeName, bool enable) |
| Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction.
|
|
void | AllocateNetworkState () |
| Allocate network attribute state.
|
|
void | WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp) |
| Write initial delta network update.
|
|
void | WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp) |
| Write a delta network update according to dirty attribute bits.
|
|
void | WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp) |
| Write a latest data network update.
|
|
bool | ReadDeltaUpdate (Deserializer &source) |
| Read and apply a network delta update. Return true if attributes were changed.
|
|
bool | ReadLatestDataUpdate (Deserializer &source) |
| Read and apply a network latest data update. Return true if attributes were changed.
|
|
Variant | GetAttribute (unsigned index) const |
| Return attribute value by index. Return empty if illegal index.
|
|
Variant | GetAttribute (const String &name) const |
| Return attribute value by name. Return empty if not found.
|
|
Variant | GetAttributeDefault (unsigned index) const |
| Return attribute default value by index. Return empty if illegal index.
|
|
Variant | GetAttributeDefault (const String &name) const |
| Return attribute default value by name. Return empty if not found.
|
|
unsigned | GetNumAttributes () const |
| Return number of attributes.
|
|
unsigned | GetNumNetworkAttributes () const |
| Return number of network replication attributes.
|
|
bool | IsTemporary () const |
| Return whether is temporary.
|
|
bool | GetInterceptNetworkUpdate (const String &attributeName) const |
| Return whether an attribute's network updates are being intercepted.
|
|
NetworkState * | GetNetworkState () const |
| Return the network attribute state, if allocated.
|
|
| Object (Context *context) |
| Construct.
|
|
| ~Object () override |
| Destruct. Clean up self from event sender & receiver structures.
|
|
virtual StringHash | GetType () const =0 |
| Return type hash.
|
|
virtual const String & | GetTypeName () const =0 |
| Return type name.
|
|
virtual const TypeInfo * | GetTypeInfo () const =0 |
| Return type info.
|
|
virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event.
|
|
bool | IsInstanceOf (StringHash type) const |
| Check current instance is type of specified type.
|
|
bool | IsInstanceOf (const TypeInfo *typeInfo) const |
| Check current instance is type of specified type.
|
|
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 | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender.
|
|
void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event.
|
|
void | SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| Subscribe to an event that can be sent by any sender.
|
|
void | SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| 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 PODVector< StringHash > &exceptions, bool onlyUserData) |
| Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
|
|
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, Args... args) |
| Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
|
|
Context * | GetContext () const |
| Return execution context.
|
|
const Variant & | GetGlobalVar (StringHash key) const |
| Return global variable based on key.
|
|
const VariantMap & | GetGlobalVars () const |
| Return all global variables.
|
|
void | SetGlobalVar (StringHash key, const Variant &value) |
| Set global variable with the respective key and 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 String & | GetCategory () const |
| Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
|
|
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.
|
|
void | AddRef () |
| Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
|
|
void | ReleaseRef () |
| Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
|
|
int | Refs () const |
| Return reference count.
|
|
int | WeakRefs () const |
| Return weak reference count.
|
|
RefCount * | RefCountPtr () |
| Return pointer to the reference count structure.
|
|