@kognifai/cogsengine
    Preparing search index...

    Class TwinCadModelComponent

    Component that control Kognitwin's visuals.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    allowClipping attributeMap clipping customEffect diffuseColor emissiveColor hasAttributeData isTyped maxClipping metallic minClipping numSubstanceDefinitionMaps parameters pbrLightmodel roughness selectionEffect specularColor specularPower substance substanceParams surfaceVariance surfaceVarianceTexture

    Accessors

    entity name type

    Methods

    create wrap

    Constructors

    • Internal: Component constructor

      Parameters

      • type: string

        type of the component. Ex. "TransformComponent"

      • entity: Entity | null

        Owning entity. Entity only passed when wrapping existing entity.

      Returns TwinCadModelComponent

    Properties

    allowClipping: boolean
    attributeMap: BufferViewUint8 | null

    Attribute map for embedded ids Currently follows the twin texture layout:

    clipping: vec4
    customEffect: number
    diffuseColor: vec4
    emissiveColor: vec3
    hasAttributeData: boolean
    isTyped: boolean = false

    Internal flag set if component is a Cogs Core component.

    maxClipping: vec3
    metallic: number
    minClipping: vec3
    numSubstanceDefinitionMaps: number
    parameters: vec4
    pbrLightmodel: boolean
    roughness: number
    selectionEffect: number
    specularColor: vec3
    specularPower: number
    substance: string
    substanceParams: vec3
    surfaceVariance: boolean
    surfaceVarianceTexture: TextureResource | null

    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