M3D / M3D / M3DMath / Color

Class: Color

M3D.M3DMath.Color

Memberof

M3D.M3DMath

Description

颜色

Date

2022-1-12

Copyright

All Rights Reserved. Copyright (C) 2022 HOTEAMSOFT, Ltd

Table of contents

Constructors

• constructor

Properties

• a
• b
• g
• r
• black
• blue
• colorCount
• cyan
• default
• edgeDefaultColor
• edgeSelectColor
• faceDefaultColor
• faceSelectColor
• gray
• green
• magenta
• pathPointColor
• red
• selectColor
• selectorShelter
• transparent
• white
• yellow

Methods

• Abs
• Add
• AddED
• Average
• Bounds
• Chroma
• Clip
• Clone
• Data
• FromHCM
• FromHSL
• FromHSV
• FromHexadecimal
• FromString
• FromUintString
• Hue
• Invert
• IsTransparent
• Lerp
• Lightness
• Luma
• MaxRGB
• MinRGB
• Range
• SaturationHSL
• SaturationHSV
• Sub
• SumRGB
• ToHSL
• ToHSV
• ToUInt
• ToVector3
• ToVector4
• Value
• copyFrom
• equals
• hexToRgb
• multiply
• setColor
• toArray
• toString
• toUintString
• BLACK
• BLUE
• CYAN
• Default
• EdgeDefaultColor
• EdgeSelectColor
• FaceDefaultColor
• FaceSelectColor
• GRAY
• GREEN
• MAGENTA
• PathPointColor
• RED
• SelectColor
• SelectorShelter
• TRANSPARENT
• WHITE
• YELLOW

Constructors

constructor

• new Color(): Color

Returns

Color

Description

构造函数

• new Color(color): Color

Parameters

Name	Type
color	Color

Returns

Color

Description

构造函数

• new Color(data): Color

Parameters

Name	Type
data	Float32Array

Returns

Color

Description

构造函数

• new Color(color, a): Color

Parameters

Name	Type
color	Color
a	number

Returns

Color

Description

构造函数

• new Color(r, g, b): Color

Parameters

Name	Type
r	number
g	number
b	number

Returns

Color

Description

构造函数

• new Color(r, g, b, a): Color

Parameters

Name	Type
r	number
g	number
b	number
a	number

Returns

Color

Description

构造函数

Properties

a

• a: number

Brief

Alpha value.

---

b

• b: number

Brief

Blue value.

---

g

• g: number

Brief

Green value.

---

r

• r: number

Brief

Red value.

---

black

▪ Static black: Color

Brief

Opaque black .

---

blue

▪ Static blue: Color

Brief

Opaque blue .

---

colorCount

▪ Static colorCount: number

---

cyan

▪ Static cyan: Color

Brief

Opaque cyan .

---

default

▪ Static default: Color

---

edgeDefaultColor

▪ Static edgeDefaultColor: Color

---

edgeSelectColor

▪ Static edgeSelectColor: Color

---

faceDefaultColor

▪ Static faceDefaultColor: Color

---

faceSelectColor

▪ Static faceSelectColor: Color

---

gray

▪ Static gray: Color

Brief

Opaque gray .

---

green

▪ Static green: Color

Brief

Opaque green .

---

magenta

▪ Static magenta: Color

Brief

Opaque magenta .

---

pathPointColor

▪ Static pathPointColor: Color

---

red

▪ Static red: Color

Brief

Opaque red .

---

selectColor

▪ Static selectColor: Color

---

selectorShelter

▪ Static selectorShelter: Color

---

transparent

▪ Static transparent: Color

Brief

Transparent (black with no alpha).

---

white

▪ Static white: Color

Brief

Opaque white color.

---

yellow

▪ Static yellow: Color

Brief

Opaque yellow .

Methods

Abs

▸ Abs(): Color

Returns

Color

Description

获取颜色绝对值

---

Add

▸ Add(rhs): Color

Parameters

Name	Type
rhs	Color

Returns

Color

Description

颜色值相加（返回新颜色对象）

---

AddED

▸ AddED(rhs): void

Parameters

Name	Type
rhs	Color

Returns

void

Description

颜色值相加（在原基础上相加，不生成新的颜色对象）

---

Average

▸ Average(): number

Returns

number

Description

获取RGB平均值

---

Bounds

▸ Bounds(bound, clipped?): void

Parameters

Name	Type
bound	number[]
clipped?	boolean

Returns

void

Description

获取RGB中最大最小值

---

Chroma

▸ Chroma(): number

Returns

number

Description

获取颜色彩度值

---

Clip

▸ Clip(clipAlpha): void

Parameters

Name	Type	Description
clipAlpha	boolean	是否换算alpha值

Returns

void

Description

将RGBA换算至[0,1]范围内

---

Clone

▸ Clone(): Color

Returns

Color

Description

克隆颜色对象

---

Data

▸ Data(): Float32Array

Returns

Float32Array

Description

获取颜色数据

---

FromHCM

▸ FromHCM(h, c, m): void

Parameters

Name	Type
h	number
c	number
m	number

Returns

void

Description

根据HRC获取rgb

---

FromHSL

▸ FromHSL(h, s, l, a): void

Parameters

Name	Type
h	number
s	number
l	number
a	number

Returns

void

Description

根据HSL及Alpha值获取RGBA

---

FromHSV

▸ FromHSV(h, s, v, a): void

Parameters

Name	Type
h	number
s	number
v	number
a	number

Returns

void

Description

根据HSV及Alpha值获取RGBA

---

FromHexadecimal

▸ FromHexadecimal(hex): void

Parameters

Name	Type
hex	number

Returns

void

Description

十六进制数转RGB

---

FromString

▸ FromString(str, splitKey): void

Parameters

Name	Type
str	string
splitKey	string

Returns

void

Description

根据字符串，获取颜色数据

---

FromUintString

▸ FromUintString(str, splitKey): void

Parameters

Name	Type
str	string
splitKey	string

Returns

void

Description

根据uint格式字符串，获取颜色数据

---

Hue

▸ Hue(min, max): number

Parameters

Name	Type
min	number
max	number

Returns

number

Description

获取色调值（范围[0,1)）

---

Invert

▸ Invert(invertAlpha): void

Parameters

Name	Type	Description
invertAlpha	boolean	透明度是否反转

Returns

void

Description

颜色反转

---

IsTransparent

▸ IsTransparent(): boolean

Returns

boolean

Description

判断颜色是否半透明

---

Lerp

▸ Lerp(rhs, t): Color

Parameters

Name	Type
rhs	Color
t	number

Returns

Color

Description

返回两颜色线性插值（颜色渐变色）

---

Lightness

▸ Lightness(): number

Returns

number

Description

获取颜色亮度

---

Luma

▸ Luma(): number

Returns

number

Description

获取颜色亮度

---

MaxRGB

▸ MaxRGB(): number

Returns

number

Description

获取RGB最大值

---

MinRGB

▸ MinRGB(): number

Returns

number

Description

获取RGB最小值

---

Range

▸ Range(): number

Returns

number

Description

获取RGB最大最小值差

---

SaturationHSL

▸ SaturationHSL(min, max): number

Parameters

Name	Type
min	number
max	number

Returns

number

Description

获取HSL格式中颜色饱和度值

---

SaturationHSV

▸ SaturationHSV(): number

Returns

number

Description

获取HSV格式饱和度

▸ SaturationHSV(min, max): number

Parameters

Name	Type
min	number
max	number

Returns

number

Description

获取HSV格式饱和度

---

Sub

▸ Sub(rhs): Color

Parameters

Name	Type
rhs	Color

Returns

Color

Description

颜色值相减

---

SumRGB

▸ SumRGB(): number

Returns

number

Description

获取RGB值总和

---

ToHSL

▸ ToHSL(): Vector3

Returns

Vector3

Description

返回颜色HSL格式数据

---

ToHSV

▸ ToHSV(): Vector3

Returns

Vector3

Description

返回颜色HSV格式数据

---

ToUInt

▸ ToUInt(): number

Returns

number

Description

颜色值转Uint格式

---

ToVector3

▸ ToVector3(): Vector3

Returns

Vector3

Description

RGB转三维向量

---

ToVector4

▸ ToVector4(): Vector4

Returns

Vector4

Description

RGBA转四维向量

---

Value

▸ Value(): number

Returns

number

Description

获取RGB最大值

---

copyFrom

▸ copyFrom(rhs): void

Parameters

Name	Type
rhs	Color

Returns

void

Description

复制颜色RGBA

---

equals

▸ equals(rhs): boolean

Parameters

Name	Type
rhs	Color

Returns

boolean

Description

判断颜色是否一致

---

hexToRgb

▸ hexToRgb(hex): void

Parameters

Name	Type
hex	string

Returns

void

Description

十六进制字符串转RGB

---

multiply

▸ multiply(rhs): Color

Parameters

Name	Type
rhs	number

Returns

Color

Description

颜色值相乘

---

setColor

▸ setColor(r, g, b, a?): void

Parameters

Name	Type
r	number
g	number
b	number
a?	number

Returns

void

Description

设置颜色RGBA

---

toArray

▸ toArray(): number[]

Returns

number[]

Description

颜色对象转数组数据

---

toString

▸ toString(): string

Returns

string

Description

颜色对象转字符串信息

---

toUintString

▸ toUintString(): string

Returns

string

Description

颜色对象转字符串信息（255，255，255，1）

---

BLACK

▸ BLACK(): Color

Returns

Color

Description

获取黑色

---

BLUE

▸ BLUE(): Color

Returns

Color

Description

获取蓝色

---

CYAN

▸ CYAN(): Color

Returns

Color

Description

获取青色

---

Default

▸ Default(): Color

Returns

Color

Description

获取默认颜色

---

EdgeDefaultColor

▸ EdgeDefaultColor(): Color

Returns

Color

Description

获取边界线默认颜色

---

EdgeSelectColor

▸ EdgeSelectColor(): Color

Returns

Color

Description

获取边界线选中颜色

---

FaceDefaultColor

▸ FaceDefaultColor(): Color

Returns

Color

Description

获取面默认颜色

---

FaceSelectColor

▸ FaceSelectColor(): Color

Returns

Color

Description

获取面选中颜色

---

GRAY

▸ GRAY(): Color

Returns

Color

Description

获取灰色

---

GREEN

▸ GREEN(): Color

Returns

Color

Description

获取绿色

---

MAGENTA

▸ MAGENTA(): Color

Returns

Color

Description

获取洋红色

---

PathPointColor

▸ PathPointColor(): Color

Returns

Color

Description

获取路径点颜色

---

RED

▸ RED(): Color

Returns

Color

Description

获取红色

---

SelectColor

▸ SelectColor(): Color

Returns

Color

Description

获取选中颜色

---

SelectorShelter

▸ SelectorShelter(): Color

Returns

Color

Description

获取选中颜色

---

TRANSPARENT

▸ TRANSPARENT(): Color

Returns

Color

Description

获取透明颜色

---

WHITE

▸ WHITE(): Color

Returns

Color

Description

获取白色

---

YELLOW

▸ YELLOW(): Color

Returns

Color

Description

获取黄色