Class Fingerprint

Hierarchy

  • DataObject
    • Fingerprint

Constructors

constructor

Properties

classifier createdTimestamp displayName features parentUID processed uid vector

Accessors

position relativePositions source

Methods

addFeature addRelativePosition bind clone computeVector getPosition getRelativePosition getRelativePositions hasFeature hasRelativePosition removeRelativePositions setParent setPosition setUID

Constructors

constructor

Properties

classifier

classifier: string

createdTimestamp

createdTimestamp: number

Created timestamp

displayName

displayName: string

Object display name

features

features: Map<string, FingerprintFeature> = ...

parentUID

parentUID: string

processed

processed: boolean

uid

uid: string

Object identifier

Returns

Unique object identifier

vector

vector: number[]

Accessors

position

  • get position(): AbsolutePosition

  • Get the current absolute position of the object relative to the global reference space

    Returns AbsolutePosition

    Absolute position of data object

  • set position(position): void

  • Set the current absolute position of the object relative to the global reference space

    Parameters

    • position: AbsolutePosition

    Returns void

relativePositions

  • get relativePositions(): RelativePosition<any, Unit>[]

  • Get relative positions

    Returns RelativePosition<any, Unit>[]

    Array of relative positions

  • set relativePositions(relativePostions): void

  • Parameters

    • relativePostions: RelativePosition<any, Unit>[]

    Returns void

source

  • set source(obj): void

  • Set the fingerprint source. This can be used to identify the user or device that captured the data.

    Parameters

    • obj: DataObject

      Fingerprint source

    Returns void

Methods

addFeature

  • addFeature(key, value): this

  • Add a feature to the fingerprint

    Parameters

    • key: string

      Feature key

    • value: number

      Feature value

    Returns this

    instance

addRelativePosition

  • addRelativePosition(relativePosition): this

  • Add a relative position to this data object

    Parameters

    • relativePosition: RelativePosition<any, Unit>

      Relative position to add

    Returns this

    Data object instance

bind

  • bind(service): DataObjectBinding<Fingerprint>

  • Bind the data object to a service

    Parameters

    • service: DataService<string, Fingerprint>

      Service to bind it to

    Returns DataObjectBinding<Fingerprint>

    Data object binding with a service

clone

  • clone<T>(dataType?): T

  • Clone the data object

    Type Parameters

    Parameters

    • Optional dataType: Constructor<T>

      Data type to clone to

    Returns T

    Cloned data object

computeVector

  • computeVector(aggFn): void

  • Compute the relative position vector from the relative positions

    Parameters

    • aggFn: ((values, key?) => number)

      Aggregation function

        • (values, key?): number

        • Parameters

          • values: number[]
          • Optional key: string

          Returns number

    Returns void

getPosition

  • getPosition(referenceSpace?): AbsolutePosition

  • Get the current absolute position of the object

    Parameters

    • Optional referenceSpace: TransformationSpace

      Reference space to transform it to

    Returns AbsolutePosition

    Position of the data object

getRelativePosition

  • getRelativePosition(referenceObjectUID, type?): RelativePosition<any, Unit>

  • Get relative position of a specified object

    Parameters

    • referenceObjectUID: string

      Reference object identifier

    • Optional type: string

      Constructor type of the relative position

    Returns RelativePosition<any, Unit>

    Relative position to reference object

getRelativePositions

  • getRelativePositions(referenceObjectUID?): RelativePosition<any, Unit>[]

  • Get relative positions for a different target

    Parameters

    • Optional referenceObjectUID: string

      Reference object identifier

    Returns RelativePosition<any, Unit>[]

    Array of relative positions for the reference object

hasFeature

  • hasFeature(key): boolean

  • Check if a fingerprint has a feature

    Parameters

    • key: string

      Feature key

    Returns boolean

    Existance of feature

hasRelativePosition

  • hasRelativePosition(referenceObjectUID): boolean

  • Parameters

    • referenceObjectUID: string

    Returns boolean

removeRelativePositions

  • removeRelativePositions(referenceObjectUID): void

  • Parameters

    • referenceObjectUID: string

    Returns void

setParent

  • setParent(object): this

  • Set a parent object to the data object

    Parameters

    • object: string | DataObject

      Data object or UID to add as parent

    Returns this

    instance

setPosition

  • setPosition(position, referenceSpace?): this

  • Set the current absolute position of the object

    Parameters

    • position: AbsolutePosition

      Position to set

    • Optional referenceSpace: TransformationSpace

      Reference space

    Returns this

    Data object instance

setUID

  • setUID(uid): this

  • Set the unique identifier of this object

    Parameters

    • uid: string

      Unique Identifier

    Returns this

    Data object instance

Settings

Member Visibility

Theme

On This Page

constructorclassifiercreatedTimestampdisplayNamefeaturesparentUIDprocesseduidvectorpositionrelativePositionssourceaddFeatureaddRelativePositionbindclonecomputeVectorgetPositiongetRelativePositiongetRelativePositionshasFeaturehasRelativePositionremoveRelativePositionssetParentsetPositionsetUID