Question

mxcad API 文档 / 2d / Color

Class: Color

2d.Color

Color 颜色类

Param

与new THREE.Color 的参数一样 也可以是自身

Example

import { Color, ColorIndexType } from "mxcad"
new Color()
new Color("#fff")
new Color("rgb(255, 255, 255)")
new Color(255, 255, 255)
new Color(0XFFFFFF)
new Color(new Mx.MxFun.getMxFunTHREE().Color())
new Color({
 colorIndex: ColorIndexType.kByblock,
})
// 获取css 颜色样式
new Color().getStyle()

Hierarchy

• ObjectInheritance

• McCmColor

  ↳ Color

Table of contents

Constructors

• constructor

Properties

• getStyle
• h
• l
• s
• set
• setHSL
• toJSON

Accessors

• blue
• colorIndex
• green
• method
• n
• red
• indexColors

Methods

• clone
• copy
• getColorString
• getColorValue
• getImp
• setColorIndex
• setRGB

Constructors

constructor

• new Color(...ages)

Parameters

Name	Type
...ages	CreateColorArgs \	[Color]

Overrides

McCmColor.constructor

Properties

getStyle

• getStyle: () => string

Type declaration

▸ (): string

获取css样式

Returns

string

---

h

• h: number

---

l

• l: number

---

s

• s: number

---

set

• set: (...ages: CreateColorArgs) => Color

Type declaration

▸ (...ages): Color

设置颜色

Parameters

Name	Type
...ages	CreateColorArgs

Returns

Color

---

setHSL

• setHSL: (h: number, s: number, l: number) => Color

Type declaration

▸ (h, s, l): Color

设置HSL 值

Parameters

Name	Type
h	number
s	number
l	number

Returns

Color

---

toJSON

• toJSON: () => McCmColorJSON

Type declaration

▸ (): McCmColorJSON

Returns

McCmColorJSON

Accessors

blue

• get blue(): number

蓝色值。

Returns

number

• set blue(val): void

Parameters

Name	Type
val	number

Returns

void

---

colorIndex

• get colorIndex(): number

颜色索引。。

Returns

number

• set colorIndex(val): void

Parameters

Name	Type
val	number

Returns

void

---

green

• get green(): number

绿色值。

Returns

number

• set green(val): void

Parameters

Name	Type
val	number

Returns

void

---

method

• get method(): number

方法。

Returns

number

• set method(val): void

Parameters

Name	Type
val	number

Returns

void

---

n

• get n(): number

n

Returns

number

• set n(val): void

Parameters

Name	Type
val	number

Returns

void

---

red

• get red(): number

红色值。

Returns

number

• set red(val): void

Parameters

Name	Type
val	number

Returns

void

---

indexColors

• Static get indexColors(): Color[]

全部的颜色索引

Returns

Color[]

Methods

clone

▸ clone(): McCmColor

刻隆一个对对象

Returns

McCmColor

Inherited from

McCmColor.clone

---

copy

▸ copy(val): Color

复制对象的值

Parameters

Name	Type
val	McCmColor

Returns

Color

Inherited from

McCmColor.copy

---

getColorString

▸ getColorString(): string

得到颜色说明字符串

Returns

string

Inherited from

McCmColor.getColorString

---

getColorValue

▸ getColorValue(layerId?, blkRefId?): string

得到颜色值字符串，十六进制格式，layerId:颜色随层时会取layerId指向的层颜色，blkRefId:颜色随块时，会取blkRefId指向的块颜色.

Parameters

Name	Type
layerId?	McObjectId
blkRefId?	McObjectId

Returns

string

Inherited from

McCmColor.getColorValue

---

getImp

▸ getImp(): any

Returns

any

Inherited from

McCmColor.getImp

---

setColorIndex

▸ setColorIndex(colorIndex): void

设置颜色索引。

Parameters

Name	Type	Description
colorIndex	number	颜色索引。

Returns

void

Inherited from

McCmColor.setColorIndex

---

setRGB

▸ setRGB(red, green, blue): void

设置 RGB 值。

Parameters

Name	Type	Description
red	number	红色值。
green	number	绿色值。
blue	number	蓝色值。

Returns

void

Inherited from

McCmColor.setRGB