API / PolygonBoundingBoxData

Class: PolygonBoundingBoxData

Defined in: model/BoundingBoxData.ts:484

The polygon bounding box data.

Extends

• BoundingBoxData

Constructors

Constructor

new PolygonBoundingBoxData(): PolygonBoundingBoxData;

Returns

PolygonBoundingBoxData

Inherited from

BoundingBoxData.constructor

Properties

hashCode

readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

BoundingBoxData.hashCode

---

type

type: BoundingBoxType;

Defined in: model/BoundingBoxData.ts:44

The bounding box type.

Inherited from

BoundingBoxData.type

---

vertices

readonly vertices: number[] = [];

Defined in: model/BoundingBoxData.ts:650

The polygon vertices.

Methods

containsPoint()

containsPoint(pX: number, pY: number): boolean;

Defined in: model/BoundingBoxData.ts:663

Check whether the bounding box contains a specific point. (Local coordinate system)

Parameters

Parameter	Type
pX	number
pY	number

Returns

boolean

Overrides

BoundingBoxData.containsPoint

---

intersectsSegment()

intersectsSegment(
   xA: number, 
   yA: number, 
   xB: number, 
   yB: number, 
   intersectionPointA: object, 
   intersectionPointB: object, 
   normalRadians: object): number;

Defined in: model/BoundingBoxData.ts:686

Check whether the bounding box intersects a specific segment. (Local coordinate system)

Parameters

Parameter	Type	Default value
xA	number	undefined
yA	number	undefined
xB	number	undefined
yB	number	undefined
intersectionPointA	{ x: number; y: number; }	null
intersectionPointA.x	number	undefined
intersectionPointA.y	number	undefined
intersectionPointB	{ x: number; y: number; }	null
intersectionPointB.x	number	undefined
intersectionPointB.y	number	undefined
normalRadians	{ x: number; y: number; }	null
normalRadians.x	number	undefined
normalRadians.y	number	undefined

Returns

number

Overrides

BoundingBoxData.intersectsSegment

---

returnToPool()

returnToPool(): void;

Defined in: core/BaseObject.ts:167

Clear the object and return it back to object pool。

Returns

void

Inherited from

BoundingBoxData.returnToPool

---

borrowObject()

static borrowObject<T>(objectConstructor: () => T): T;

Defined in: core/BaseObject.ts:136

Get an instance of the specify class from object pool.

Type Parameters

Type Parameter
T extends BaseObject

Parameters

Parameter	Type	Description
objectConstructor	() => T	The specify class.

Returns

T

Inherited from

BoundingBoxData.borrowObject

---

clearPool()

static clearPool(objectConstructor: typeof BaseObject): void;

Defined in: core/BaseObject.ts:111

Clear the cached instances of a specify object pool.

Parameters

Parameter	Type	Default value	Description
objectConstructor	typeof BaseObject	null	Specify class. (Clear all cached instances if not set)

Returns

void

Inherited from

BoundingBoxData.clearPool

---

setMaxCount()

static setMaxCount(objectConstructor: typeof BaseObject, maxCount: number): void;

Defined in: core/BaseObject.ts:72

Set the maximum cache count of the specify object pool.

Parameters

Parameter	Type	Description
objectConstructor	typeof BaseObject	The specify class. (Set all object pools max cache count if not set)
maxCount	number	Max count.

Returns

void

Inherited from

BoundingBoxData.setMaxCount

---

toString()

static toString(): string;

Defined in: model/BoundingBoxData.ts:485

Returns

string

Overrides

BoundingBoxData.toString