@kognifai/cogsengine
    Preparing search index...

    Class ClipShapeComponent

    Sets up a clipping shape that can be used by multiple entities.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    isTyped max min shape

    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 ClipShapeComponent

    Properties

    isTyped: boolean

    Internal flag set if component is a Cogs Core component.

    max: vec3

    The high-end corner of cube-shapes.

    min: vec3

    The low-end corner of cube-shapes.

    shape: ClipShapeType

    The basic shape of the clip region.

    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