Home Reference Source Repository

import CGPoint from 'jscenekit/js/CoreGraphics/CGPoint.js'

public class | source

CGPoint

A structure that contains a point in a two-dimensional coordinate system.

See:

https://developer.apple.com/documentation/coregraphics/cgpoint

Static Member Summary

Static Public Members
public static get	zero: CGPoint

Static Method Summary

Static Public Methods
public static	pointWithDictionaryRepresentation(dict: Map): void Creates a point from a canonical dictionary representation.

Constructor Summary

Public Constructor
public	constructor(x: number, y: number) Creates a point with coordinates specified as integer values.

Member Summary

Public Members
public get	customMirror: Mirror Mirrors are used by playgrounds and the debugger.
public get	customPlaygroundQuickLook: PlaygroundQuickLook
public get	debugDescription: string
public get	dictionaryRepresentation: Map
public	x: *
public	y: *

Method Summary

Public Methods
public	add(p: CGPoint): CGPoint
public	applying(t: CGAffineTransform): CGPoint Returns the point resulting from an affine transformation of an existing point.
public	copy(): CGPoint
public	dot(p: CGPoint): number
public	equalTo(point2: CGPoint): boolean Returns whether two points are equal.
public	float32Array(): Float32Array
public	floatArray(): number[]
public	length(): number
public	lerp(p: CGPoint, rate: number): CGPoint
public	mul(n: number): CGPoint
public	normalize(): CGPoint
public	sub(p: CGPoint): CGPoint
public	zero(): *

Static Public Members

public static get zero: CGPoint source

See:

https://developer.apple.com/documentation/coregraphics/cgpoint/1454433-zero

Static Public Methods

public static pointWithDictionaryRepresentation(dict: Map): void source

Creates a point from a canonical dictionary representation.

Params:

Name	Type	Attribute	Description
dict	Map		A dictionary containing x and y values for the point to create, in the format used by the dictionaryRepresentation property.

Return:

void

See:

https://developer.apple.com/documentation/coregraphics/cgpoint/2427118-init

Public Constructors

public constructor(x: number, y: number) source

Creates a point with coordinates specified as integer values.

Params:

Name	Type	Attribute	Description
x	number
y	number

See:

https://developer.apple.com/documentation/coregraphics/cgpoint/1455965-init

Public Members

public get customMirror: Mirror source

Mirrors are used by playgrounds and the debugger.

See:

https://developer.apple.com/documentation/coregraphics/cgpoint/1645834-custommirror

public get customPlaygroundQuickLook: PlaygroundQuickLook source

See:

https://developer.apple.com/documentation/coregraphics/cgpoint/1645835-customplaygroundquicklook

public get debugDescription: string source

See:

https://developer.apple.com/documentation/coregraphics/cgpoint/1645825-debugdescription

public get dictionaryRepresentation: Map source

See:

https://developer.apple.com/documentation/coregraphics/cgpoint/1455382-dictionaryrepresentation

public x: * source

public y: * source

Public Methods

public add(p: CGPoint): CGPoint source

Params:

Name	Type	Attribute	Description
p	CGPoint

Return:

public applying(t: CGAffineTransform): CGPoint source

Returns the point resulting from an affine transformation of an existing point.

Params:

Name	Type	Attribute	Description
t	CGAffineTransform		The affine transform to apply.

Return:

See:

https://developer.apple.com/documentation/coregraphics/cgpoint/1454251-applying

public copy(): CGPoint source

Return:

public dot(p: CGPoint): number source

Params:

Name	Type	Attribute	Description
p	CGPoint

Return:

public equalTo(point2: CGPoint): boolean source

Returns whether two points are equal.

Params:

Name	Type	Attribute	Description
point2	CGPoint

Return:

See:

https://developer.apple.com/documentation/coregraphics/cgpoint/1456179-equalto

public float32Array(): Float32Array source

Return:

public floatArray(): number[] source

Return:

public length(): number source

Return:

public lerp(p: CGPoint, rate: number): CGPoint source

Params:

Name	Type	Attribute	Description
p	CGPoint
rate	number

Return:

public mul(n: number): CGPoint source

Params:

Name	Type	Attribute	Description
n	number

Return:

public normalize(): CGPoint source

Return:

public sub(p: CGPoint): CGPoint source

Params:

Name	Type	Attribute	Description
p	CGPoint

Return:

public zero(): * source

Return:

*