Interface TransformationSpace

A transformation space transforms absolute positions to another (global) space.

interface TransformationSpace {
    parent: TransformationSpace;
    uid: string;
    transform<In extends AbsolutePosition, Out extends AbsolutePosition = In>(
        position: In,
        options?: SpaceTransformationOptions,
    ): Out;
    update(service: DataService<any, TransformationSpace>): Promise<void>;
}

Implemented by

ReferenceSpace

Index

Properties

Methods

transform update

Properties

parent

parent: TransformationSpace

Set the parent space

Param: space

Parent space

uid

uid: string

Unique uuidv4 identifier of the transformation space

Methods

transform

transform<In extends AbsolutePosition, Out extends AbsolutePosition = In>(
position: In,
options?: SpaceTransformationOptions,
): Out
Transform a position
Type Parameters
- In extends AbsolutePosition
- Out extends AbsolutePosition = In
Parameters
- position: In
  Position to transform
- Optionaloptions: SpaceTransformationOptions
  Transformation options
Returns Out
Transformed position
- Defined in src/data/object/space/TransformationSpace.ts:31

update

update(service: DataService<any, TransformationSpace>): Promise<void>
Update parent reference spaces
Parameters
- service: DataService<any, TransformationSpace>
  Service to use for updating
Returns Promise<void>
Update promise
- Defined in src/data/object/space/TransformationSpace.ts:23