@kognifai/cogsengine
    Preparing search index...

    Class InstancedMeshRenderComponent

    Renders a mesh using instancing.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    drawOrder instanceCount instanceIdMultiplier instanceMesh isTyped layer material objectId primitiveType renderFlags startIndex startInstance vertexCount

    Accessors

    entity name type

    Methods

    create wrap

    Constructors

    Properties

    drawOrder: number

    Draw order within a render bucke. Useful to control transparency overdraw. This value will be overriden by the material's draworder if that is nonzero.

    instanceCount: number

    Instance count. uint32_t(-1) to draw all remaining instances.

    instanceIdMultiplier: number

    Multiplier used when embedding instance ids into picking results. If geometry mesh texcoord ids run in [0, N), setting multiplier to N will stack the ids of the instances on top of eachother. Set to zero to disable embedding of instance ids.

    instanceMesh: Mesh | null

    Mesh containing instancing data. Setting mesh bounds for the instance mesh will avoid calculations, in particular for instance matrices. These bounds are extended by the bounds by the geometry mesh.

    isTyped: boolean = false

    Internal flag set if component is a Cogs Core component.

    layer: RenderLayers

    Layer mask used to determine visibility for a given camera viewport. The layer mask is combined with that of the camera. The resulting value can then be combined with the result of isVisible() to form a final visibility value.

    material: MaterialInstance | null

    Material instance used to render the mesh.

    objectId: number

    Object identifier passed to rendering commands.

    primitiveType: PrimitiveType

    Primitive type to use when drawing. Default value -1 means use primitive type from mesh.

    renderFlags: RenderFlags

    Render flags used to control rendering behavior.

    startIndex: number

    Start vertex index to render from.

    startInstance: number

    Start instance.

    vertexCount: number

    Number of vertexes to draw. uint32_t(-1) to draw all remaining vertices.

    Accessors

    • get entity(): Entity | null

      Gets the optional owning entity

      Returns Entity | null

    • set entity(entity: Entity | null): void

      Internal: set owning entity.

      Parameters

      Returns void

    • get name(): string

      Component name == type. For compatibility

      Returns string

    • get type(): string

      Gets the type of the component. Ex. "TransformComponent", "SceneComponent" etc.

      Returns string

    Methods

    • Internal: Creates a new component of the given type (name). Component is wrapped when adding to an entity.

      Parameters

      • type: string

        Type of the component. Ex. "TransformComponent"

      Returns Component

      Created Cogs.js component.

    • Internal: Creates a new component being wrapped as an existing member of the entity

      Parameters

      • type: string

        Type of the component. Ex. "TransformComponent"

      • entity: Entity

        The owning entity

      Returns Component

      Created Cogs.js component.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods