Class AnnotationAxisComponent

Component in Extension AxisCube

Hierarchy (View Summary)

Component
- AnnotationAxisComponent

Index

Constructors

Properties

distance isTyped positions strings viewDependentAnchor viewDependentAnchorReference

Accessors

entity name type

Methods

Constructors

constructor

new AnnotationAxisComponent(
type: string,
entity: Entity,
): AnnotationAxisComponent
Internal: Component constructor
Parameters
- type: string
  type of the component. Ex. "TransformComponent"
- entity: Entity
  Owning entity. Entity only passed when wrapping existing entity.
Returns AnnotationAxisComponent
Inherited from Component.constructor
- Defined in dist/cogs.esm.d.ts:3390

Properties

distance

distance: number

isTyped

isTyped: boolean

Internal flag set if component is a Cogs Core component.

positions

positions: Float32Array

Contents: vec3[]

strings

strings: string[]

viewDependentAnchor

viewDependentAnchor: boolean

Enable or disable view-dependent anchoring of labels.

viewDependentAnchorReference

viewDependentAnchorReference: vec3

Local-space vector indicating in which direction the label should be anchored.

Accessors

entity

get entity(): Entity
Gets the optional owning entity

Returns Entity
Inherited from Component.entity
- Defined in dist/cogs.esm.d.ts:3395
set entity(entity: Entity): void
Internal: set owning entity.
Parameters
- entity: Entity
Returns void
Inherited from Component.entity
- Defined in dist/cogs.esm.d.ts:3400

name

get name(): string
Component name == type. For compatibility

Returns string
Inherited from Component.name
- Defined in dist/cogs.esm.d.ts:3408

type

get type(): string
Gets the type of the component. Ex. "TransformComponent", "SceneComponent" etc.

Returns string
Inherited from Component.type
- Defined in dist/cogs.esm.d.ts:3405

Methods

`Static`create

create(type: string): Component
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.
Inherited from Component.create
- Defined in dist/cogs.esm.d.ts:3427

`Static`wrap

wrap(type: string, entity: Entity): 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.
Inherited from Component.wrap
- Defined in dist/cogs.esm.d.ts:3419