Urho.Drawable Class

Base class for visible components.

See Also: Drawable

Syntax

public class Drawable : Component

Requirements

Namespace: Urho
Assembly: Urho (in Urho.dll)
Assembly Versions: 1.0.0.0

The members of Urho.Drawable are listed below.

See Also: Component

Public Constructors

Constructs a new instance of Urho.Drawable, given a raw pointer to an unmanaged object

Protected Constructors

Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.

Public Properties

[read-only]
BoundingBoxBoundingBox. Return local space bounding box. May not be applicable or properly updated on all drawables.
CastShadowsBoolean. Return shadowcaster flag. Or Set shadowcaster flag.
[read-only]
DistanceSingle. Return distance from camera.
[read-only]
DrawableFlagsByte. Return drawable flags.
DrawDistanceSingle. Return draw distance. Or Set draw distance.
[read-only]
FirstLightLight. Return the first added per-pixel light.
[read-only]
InViewBoolean. Return whether is in view this frame from any viewport camera. Excludes shadow map cameras.
LightMaskUInt32. Return light mask. Or Set light mask. Is and'ed with light's and zone's light mask to see if the object should be lit.
LodBiasSingle. Return LOD bias. Or Set LOD bias.
[read-only]
LodDistanceSingle. Return LOD scaled distance from camera.
MaxLightsUInt32. Return maximum number of per-pixel lights. Or Set maximum number of per-pixel lights. Default 0 is unlimited.
[read-only]
MaxZSingle. Return the maximum view-space depth.
[read-only]
MinZSingle. Return the minimum view-space depth.
[read-only]
NumOccluderTrianglesUInt32. Return number of occlusion geometry triangles.
OccludeeBoolean. Controls the occludee flag.
OccluderBoolean. Controls the occluder flag.
[read-only]
OctantOctant*. Return octree octant.
ShadowDistanceSingle. Return shadow draw distance. Or Set shadow draw distance.
ShadowMaskUInt32. Return shadow mask. Or 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.
SortValueSingle. Return sorting value. Or Set sorting value.
[read-only]
override
TypeStringHash. Urho's type system type.
[read-only]
override
TypeNameString. Urho's low-level type name.
[read-only]
static
TypeNameStaticString. Urho's low-level type name, accessible as a static method.
[read-only]
static
TypeStaticStringHash. Urho's low-level type, accessible as a static method.
[read-only]
UpdateGeometryTypeUpdateGeometryType. Return whether a geometry update is necessary, and if it can happen in a worker thread.
ViewMaskUInt32. Return view mask. Or Set view mask. Is and'ed with camera's view mask to see if the object should be rendered.
[read-only]
WorldBoundingBoxBoundingBox. Return world-space bounding box.
[read-only]
ZoneZone. Return current zone.
[read-only]
ZoneDirtyBoolean. Return whether current zone is inconclusive or dirty due to the drawable moving.
ZoneMaskUInt32. Return zone mask. Or Set zone mask. Is and'ed with zone's zone mask to see if the object should belong to the zone.

Public Methods

AddLight(Light)
Adds the specified light.
AddVertexLight(Light)
Adds the specified vertex light.
override
DrawDebugGeometry(DebugRenderer, Boolean)
Visualize the component as debug geometry.
DrawOcclusion(OcclusionBuffer) : Boolean
Draw to occlusion buffer. Return true if did not run out of triangles.
GetLodGeometry(UInt32, UInt32) : Geometry
Return the geometry for a specific LOD level.
HasBasePass(UInt32) : Boolean
Return whether has a base pass.
IsInView(Camera) : Boolean
Return whether is in view of a specific camera this frame. Pass in a null camera to allow any camera, including shadow map cameras.
LimitLights()
Sort and limit per-pixel lights to maximum allowed. Convert extra lights into vertex lights.
LimitVertexLights(Boolean)
Sort and limit per-vertex lights to maximum allowed.
MarkForUpdate()
Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
MarkInView(UInt32)
Mark in view without specifying a camera. Used for shadow casters.
override
OnSetEnabled()
Handle enabled/disabled state change.
static
RegisterObject(Context)
Register object attributes. Drawable must be registered first.
SetBasePass(UInt32)
Set base pass flag for a batch.
SetMinMaxZ(Single, Single)
Set view-space depth bounds.
SetZone(Zone, Boolean)
Set new zone. Zone assignment may optionally be temporary, meaning it needs to be re-evaluated on the next frame.