View source

class Primitive

package h3d.prim

extended by BigPrimitive, DynamicPrimitive, Instanced, MeshPrimitive, Plane2D, Quads, RawPrimitive

h3d.prim.Primitive is the base class for all 3D primitives. You can't create an instance of it and need to use one of its subclasses.

Variables

buffer:Buffer

The primitive vertex buffer, holding its vertexes data.

@:value(-1)forcedLod:Int = -1

Allow user to force a specific lod index. If set to -1, forced lod will be ignored.

indexes:Indexes

The primitive indexes buffer, holding its triangles indices.

@:value(0)read onlyrefCount:Int = 0

Current amount of references to this Primitive. Use incref and decref methods to affect this value. If it reaches 0, it will be atuomatically disposed.

Methods

alloc(engine:Engine):Void

Allocate the primitive on GPU. Used for internal usage.

decref():Void

Decrease reference count of the Primitive. If recount reaches zero, Primitive is automatically disposed when last referencing mesh is removed from scene.

dispose():Void

Dispose the primitive, freeing the GPU memory it uses.

getBounds():Bounds

Return the bounds for the primitive

getCollider():Collider

Return a local collider for the primitive

getMaterialIndexes(material:Int):{start:Int, count:Int}

Returns the number and offset of indexes for the specified material

incref():Void

Increase reference count of the Primitive.

lodCount():Int

Return the LOD count.

render(engine:Engine):Void

Render the primitive. Used for internal usage.

screenRatioToLod(screenRatio:Float):Int

selectMaterial(material:Int, lod:Int):Void

Select the specified sub material before drawin. Used for internal usage.

toString():Null<String>

Return the primitive type.

triCount():Int

The number of triangles the primitive has.

vertexCount():Int

The number of vertexes the primitive has.