@kognifai/cogsengine
    Preparing search index...

    Class RenderComponent

    Base component for all rendering content. The render component acts as a base class for all components describing rendering behavior. It provides common functionality for all rendering to toggle visibility, picking and layer behavior.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    drawOrder isTyped layer objectId renderFlags

    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 RenderComponent

    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.

    isTyped: boolean

    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.

    objectId: number

    Object identifier passed to rendering commands.

    renderFlags: RenderFlags

    Render flags used to control rendering behavior.

    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