@kognifai/cogsengine
    Preparing search index...

    Class MeshComponent

    Contains a handle to a Mesh resource to use when rendering using the MeshRenderComponent.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    isTyped meshHandle

    Accessors

    entity name type

    Methods

    create wrap

    Constructors

    • Internal: Component constructor

      Parameters

      • type: string

        type of the component. Ex. "TransformComponent"

      • entity: Entity

        Owning entity. Entity only passed when wrapping existing entity.

      Returns MeshComponent

    Properties

    isTyped: boolean

    Internal flag set if component is a Cogs Core component.

    meshHandle: Mesh

    Handle to a Mesh resource to use when rendering. The mesh handle is an owning reference to the mesh resource, ensuring that if a valid mesh handle is set, the mesh resource will not be freed until this component is destructed, or the mesh handle set to another handle. If the handle is not valid, no mesh will be passed when rendering a MeshRenderComponent attached to the same entity, and no geometry will appear on screen.

    Accessors

    • get entity(): Entity

      Gets the optional owning entity

      Returns Entity

    • set entity(entity: Entity): 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