@kognifai/cogsengine
    Preparing search index...

    Class BasicOceanComponent

    class defining a Cogs component. Defines basic properties of the component - readonly for clients 'type' and 'entity'. All component shares same class definition. The properties for accessing the fields of the component type will be filled in at runtime, e.g. for TransformComponent: getter+setter for: coordinates, position, rotation etc.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    beliefSystem color dominantWavePeriod fftTileResolutionLog2 isTyped physicallyBasedRendering reflection reflectionBrightness reflectionCamera reflectionTexFormat seaLevel significantWaveHeight transparency waves windDirection windSpeed

    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 BasicOceanComponent

    Properties

    beliefSystem: BasicOceanBeliefSystem
    color: vec4

    Color of water. Alpha taken from transparency component.

    dominantWavePeriod: number
    fftTileResolutionLog2: number
    isTyped: boolean

    Internal flag set if component is a Cogs Core component.

    physicallyBasedRendering: boolean
    reflection: BasicOceanReflection
    reflectionBrightness: number

    Multiplicative factor reflection.

    reflectionCamera: Entity
    reflectionTexFormat: string
    seaLevel: number

    Vertical displacement of average sea height.

    significantWaveHeight: number
    transparency: number

    Transparency of water.

    waves: BasicOceanWaves
    windDirection: number
    windSpeed: number

    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