Class DynamicPolygonPointAbstract

constructor

• new DynamicPolygonPoint(
      _api: BimCoreApi,
      plane: Plane,
      isVirtual: boolean,
  ): DynamicPolygonPoint

  Parameters

  • _api: BimCoreApi

    BimCoreApi API.
  • plane: Plane

    Plane that this point lies on.
  • isVirtual: boolean

    whether point is virtual or not.

  Returns DynamicPolygonPoint

isEnabled

Readonlyplane

isDeletable

• get isDeletable(): DynamicPolygonPointDeleteResult

  Check if this point can be deleted or not.

  Returns DynamicPolygonPointDeleteResult

  a DynamicPolygonPointDeleteResult.

apply

• apply(): void

  Same as calling DynamicPolygon.apply.

  Returns void

delete

• delete(): DynamicPolygonPointDeleteResult

  Deletes this point from the parent DynamicPolygon. It is possible to use isDeletable to check if point can be deleted beforehand.

  Returns DynamicPolygonPointDeleteResult

  a DynamicPolygonPointMoveResult.

move

• move(canvasCoordinate: Vertex2): DynamicPolygonPointMoveResult

  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. It is also not possible to move a point if it results in a complex polygon. The point is assigned the same x,y,z values as the coordinate where the ray intersects the plane.

  Parameters

  • canvasCoordinate: Vertex2

  Returns DynamicPolygonPointMoveResult

  a DynamicPolygonPointMoveResult.

points

• points(
      predicate?: (p: DynamicPolygonPoint) => boolean,
      backwards?: boolean,
  ): Generator<DynamicPolygonPoint, void, unknown>

  Enables iteration of all points in the polygon.

  Parameters

  • Optionalpredicate: (p: DynamicPolygonPoint) => boolean

    Optional predicate. If specified only points where the predicate returns true will be returned.
  • backwards: boolean = false

    If true then polygon point are visited in backwards direction. Default is false.

  Returns Generator<DynamicPolygonPoint, void, unknown>

  generator.

virtual

• virtual(v?: boolean): boolean

  This method has two purposes.

  1. Check if this point is virtual or not (if v is undefined). This is very useful in a UI where a different visualization for a 'virtual drag point' and a 'real drag point' may be required..

  2. Convert this point to/from virtual by specifying v.

  Parameters

  • Optionalv: boolean

    Optional. If not specified function only returns current state. If specified then point is converted to either a virtual point (v = true) or a non virtual point (v = false).

  Returns boolean

  If v was not specified then true if point is virtual, otherwise false. If v was specified it returns true if point was successfully converted. Otherwise false. A point cannot be converted from non virtual to virtual if there are 3 or less non virtual points in the polygon.

StaticIsNotVirtual

• IsNotVirtual(p: DynamicPolygonPoint): boolean

  Predicate to check if a point is virtual or not.

  Parameters

  • p: DynamicPolygonPoint

    Point to check

  Returns boolean

  true if point is not virtual, otherwise false.