Public Member Functions |
| Terrain (Context *context) |
| Construct.
|
| ~Terrain () |
| Destruct.
|
virtual void | OnSetAttribute (const AttributeInfo &attr, const Variant &src) |
| Handle attribute write access.
|
virtual void | ApplyAttributes () |
| Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
|
void | SetPatchSize (int size) |
| Set patch quads per side. Must be a power of two.
|
void | SetSpacing (const Vector3 &spacing) |
| Set vertex (XZ) and height (Y) spacing.
|
bool | SetHeightMap (Image *image) |
| Set heightmap image. Dimensions should be a power of two + 1. Uses 8-bit grayscale, or optionally red as MSB and green as LSB for 16-bit accuracy. Return true if successful.
|
void | SetMaterial (Material *material) |
| Set material.
|
void | SetDrawDistance (float distance) |
| Set draw distance for patches.
|
void | SetShadowDistance (float distance) |
| Set shadow draw distance for patches.
|
void | SetLodBias (float bias) |
| Set LOD bias for patches. Affects which terrain LOD to display.
|
void | SetViewMask (unsigned mask) |
| Set view mask for patches. Is and'ed with camera's view mask to see if the object should be rendered.
|
void | SetLightMask (unsigned mask) |
| Set light mask for patches. 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 for patches. 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 for patches. 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 for patches. Default 0 is unlimited.
|
void | SetVisible (bool enable) |
| Set visible flag for patches.
|
void | SetCastShadows (bool enable) |
| Set shadowcaster flag for patches.
|
void | SetOccluder (bool enable) |
| Set occlusion flag for patches. Occlusion uses the coarsest LOD and may potentially be too aggressive, so use with caution.
|
void | SetOccludee (bool enable) |
| Set occludee flag for patches.
|
int | GetPatchSize () const |
| Return patch quads per side.
|
const Vector3 & | GetSpacing () const |
| Return vertex and height spacing.
|
const IntVector2 & | GetNumVertices () const |
| Return heightmap size in vertices.
|
const IntVector2 & | GetNumPatches () const |
| Return heightmap size in patches.
|
Image * | GetHeightMap () const |
| Return heightmap image.
|
Material * | GetMaterial () const |
| Return material.
|
TerrainPatch * | GetPatch (unsigned index) const |
| Return patch by index.
|
TerrainPatch * | GetPatch (int x, int z) const |
| Return patch by patch coordinates.
|
float | GetHeight (const Vector3 &worldPosition) const |
| Return height at world coordinates.
|
Vector3 | GetNormal (const Vector3 &worldPosition) const |
| Return normal at world coordinates.
|
SharedArrayPtr< float > | GetHeightData () const |
| Return raw height data.
|
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 | IsVisible () const |
| Return visible flag.
|
bool | GetCastShadows () const |
| Return shadowcaster flag.
|
bool | IsOccluder () const |
| Return occluder flag.
|
bool | IsOccludee () const |
| Return occludee flag.
|
void | CreatePatchGeometry (TerrainPatch *patch) |
| Regenerate patch geometry.
|
void | UpdatePatchLod (TerrainPatch *patch) |
| Update patch based on LOD and neighbor LOD.
|
void | SetHeightMapAttr (ResourceRef value) |
| Set heightmap attribute.
|
void | SetMaterialAttr (ResourceRef value) |
| Set material attribute.
|
void | SetPatchSizeAttr (int value) |
| Set patch size attribute.
|
ResourceRef | GetHeightMapAttr () const |
| Return heightmap attribute.
|
ResourceRef | GetMaterialAttr () const |
| Return material attribute.
|
| Component (Context *context) |
| Construct.
|
virtual | ~Component () |
| Destruct.
|
virtual bool | Save (Serializer &dest) |
| Save as binary data. Return true if successful.
|
virtual bool | SaveXML (XMLElement &dest) |
| Save as XML data. Return true if successful.
|
virtual void | GetDependencyNodes (PODVector< Node * > &dest) |
| Return the depended on nodes to order network updates.
|
virtual void | DrawDebugGeometry (DebugRenderer *debug, bool depthTest) |
| Visualize the component as debug geometry.
|
void | Remove () |
| Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
|
unsigned | GetID () const |
| Return ID.
|
Node * | GetNode () const |
| Return scene node.
|
Scene * | GetScene () const |
| Return the scene the node belongs to.
|
void | GetComponents (PODVector< Component * > &dest, ShortStringHash type) const |
| Return components in the same scene node by type.
|
Component * | GetComponent (ShortStringHash 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.
|
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.
|
void | MarkNetworkUpdate () |
| Mark for attribute check on the next network update.
|
| Serializable (Context *context) |
| Construct.
|
virtual | ~Serializable () |
| Destruct.
|
virtual void | OnGetAttribute (const AttributeInfo &attr, Variant &dest) |
| Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
|
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.
|
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 | AllocateNetworkState () |
| Allocate network attribute state.
|
void | WriteInitialDeltaUpdate (Serializer &dest) |
| Write initial delta network update.
|
void | WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits) |
| Write a delta network update according to dirty attribute bits.
|
void | WriteLatestDataUpdate (Serializer &dest) |
| Write a latest data network update.
|
void | ReadDeltaUpdate (Deserializer &source) |
| Read and apply a network delta update.
|
void | ReadLatestDataUpdate (Deserializer &source) |
| Read and apply a network latest data update.
|
Variant | GetAttribute (unsigned index) |
| Return attribute value by index. Return empty if illegal index.
|
Variant | GetAttribute (const String &name) |
| Return attribute value by name. Return empty if not found.
|
unsigned | GetNumAttributes () const |
| Return number of attributes.
|
unsigned | GetNumNetworkAttributes () const |
| Return number of network replication attributes.
|
const Vector< AttributeInfo > * | GetAttributes () const |
| Return attribute descriptions, or null if none defined.
|
const Vector< AttributeInfo > * | GetNetworkAttributes () const |
| Return network replication attribute descriptions, or null if none defined.
|
| Object (Context *context) |
| Construct.
|
virtual | ~Object () |
| Destruct. Clean up self from event sender & receiver structures.
|
virtual ShortStringHash | GetType () const =0 |
| Return type hash.
|
virtual const String & | GetTypeName () const =0 |
| Return type name.
|
virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event.
|
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 | 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.
|
Context * | GetContext () const |
| Return execution context.
|
Object * | GetSubsystem (ShortStringHash 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.
|
template<class T > |
T * | GetSubsystem () const |
| Template version of returning a subsystem.
|
| 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.
|
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.
|
Heightmap terrain component.