mxcad_2d API 文档 / 2d / McCmColor

Class: McCmColor ​

2d.McCmColor

表示一个颜色对象，可以通过颜色索引或 RGB 值来设置颜色。

Example

import { McCmColor, McDbEntity} from "mxcad"
const ent = new McDbEntity();
const color = new McCmColor(255,0,0);
ent.trueColor = color;

Table of contents ​

Constructors ​

• constructor

Accessors ​

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

Methods ​

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

Constructors ​

constructor ​

• new McCmColor(red?, green?, blue?)

构造函数。设置 RGB 值。

Example

import { McCmColor } from "mxcad"

const red_color:McCmColor = new McCmColor(255, 0, 0);

const colorObj = { red:0, green:255, blue:0};
const green_color:McCmColor = new McCmColor(colorObj);

Parameters ​

Accessors ​

blue ​

• get blue(): number

获取或设置rgb值中的蓝色值，设置数值范围0~255。

Returns ​

number

• set blue(val): void

Parameters ​

Returns ​

void

colorIndex ​

• get colorIndex(): number

获取或设置颜色索引。

Returns ​

number

• set colorIndex(val): void

Parameters ​

Returns ​

void

green ​

• get green(): number

获取或设置rgb值中的绿色值，设置数值范围0~255。

Returns ​

number

• set green(val): void

Parameters ​

Returns ​

void

method ​

• get method(): number

方法。

Returns ​

number

• set method(val): void

Parameters ​

Returns ​

void

n ​

• get n(): number

n

Returns ​

number

• set n(val): void

Parameters ​

Returns ​

void

red ​

• get red(): number

获取或设置rgb值中的红色值，设置数值范围0~255。

Returns ​

number

• set red(val): void

Parameters ​

Returns ​

void

Methods ​

clone ​

▸ clone(): McCmColor

刻隆一个颜色对象

Example

import { McCmColor } from "mxcad"

const red_color:McCmColor = new McCmColor(255, 0, 0);
const copy_color:McCmColor = red_color.clone();

Returns ​

McCmColor

返回克隆后的颜色对象

copy ​

▸ copy(val): McCmColor

复制颜色对象的值。

Example

import { McCmColor } from "mxcad"

const color:McCmColor = new McCmColor();
const red_color:McCmColor = new McCmColor(255, 0, 0);
color.copy(red_color);

Parameters ​

Returns ​

McCmColor

getColorString ​

▸ getColorString(): string

得到颜色说明字符串

Returns ​

string

颜色说明字符串

getColorValue ​

▸ getColorValue(layerId?, blkRefId?): string

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

Parameters ​

Returns ​

string

颜色值字符串

getImp ​

▸ getImp(): any

获取内部实现对象

Returns ​

any

内部实现对象

getStyle ​

▸ getStyle(): string

获取 css 颜色的样式 如rgb(0, 0, 0)

Returns ​

string

setColorIndex ​

▸ setColorIndex(colorIndex): void

设置颜色索引,根据颜色索引值设置颜色类型。

Parameters ​

Returns ​

void

setRGB ​

▸ setRGB(red, green, blue): void

设置 RGB 值。

Example

import { McCmColor } from "mxcad"

const color = new McCmColor();
color.setRGB(255,0,0);

Parameters ​

Returns ​

void