Html2CanvasPoint

Hierarchy

• BimPointBase
  • Html2CanvasPoint

Index

Constructors

• constructor

Properties

• _parent
• isEnabled
• plane

Accessors

• localX
• localY
• localZ
• x
• y
• z

Methods

• move
• rotate
• scale
• setLocals
• tranlate

Constructors

publicconstructor

• new Html2CanvasPoint(_api: BimCoreApi, plane: Plane): Html2CanvasPoint

• Overrides BimPointBase.constructor

  Parameters

  • _api: BimCoreApi

    BimCoreApi API.

  • plane: Plane

    Plane that this point lies on.

  Returns Html2CanvasPoint

Properties

public_parent

_parent: HtmlPointParent<Html2CanvasPoint>

publicisEnabled

isEnabled: boolean = true

When true then onPointTrackableScreen will trigger for this instance. Otherwise it will not

publicreadonlyplane

plane: Plane

Plane that this point lies on.

Accessors

publiclocalX

• get localX(): number

• Inherited from BimPointBase.localX

  X coordinate of point in local space.

  ---

  Returns number

publiclocalY

• get localY(): number

• Inherited from BimPointBase.localY

  Y coordinate of point in local space.

  ---

  Returns number

publiclocalZ

• get localZ(): number

• Inherited from BimPointBase.localZ

  Z coordinate of point in local space.

  ---

  Returns number

publicx

• get x(): number
• set x(val: number): void

• Inherited from BimPointBase.x

  X coordinate of point in world space.

  ---

  Returns number

• Inherited from BimPointBase.x

  Set the X coordinate of point in world space.

  ---

  Parameters

  • val: number

  Returns void

publicy

• get y(): number
• set y(val: number): void

• Inherited from BimPointBase.y

  Y coordinate of point in world space.

  ---

  Returns number

• Inherited from BimPointBase.y

  Set the Y coordinate of point in world space.

  ---

  Parameters

  • val: number

  Returns void

publicz

• get z(): number
• set z(val: number): void

• Inherited from BimPointBase.z

  Z coordinate of point in world space.

  ---

  Returns number

• Inherited from BimPointBase.z

  Set the Z coordinate of point in world space.

  ---

  Parameters

  • val: number

  Returns void

Methods

publicmove

• move(canvasCoordinate: Vertex2): PointMoveResult

• Attempt to move a point to a new location on Plane. To find the location, a ray is shot from camera through canvasCoordinate and then an intersection test is performed. If the ray intersects Plane, the point is moved to the coordinates of the intersection. Otherwise nothing happens. The point is assigned the same x,y,z values as the coordinate where the ray intersects the plane.

  ---

  Parameters

  • canvasCoordinate: Vertex2

  Returns PointMoveResult

  a DynamicPolygonPointMoveResult.

publicrotate

• rotate(): void

• Returns void

publicscale

• scale(retainAspectRatio?: boolean): void

• Parameters

  • retainAspectRatio: boolean = true

  Returns void

publicsetLocals

• setLocals(x: number, y: number, z: number): void

• Inherited from BimPointBase.setLocals

  Set coordinates in local space.

  ---

  Parameters

  • x: number

    X coordinate in local space.

  • y: number

    Y coordinate in local space.

  • z: number

    Z coordinate in local space.

  Returns void

publictranlate

• tranlate(): void

• Returns void