Class Color

色を保存するクラス

Constructors

constructor

Properties

b g opacity r

Accessors

h hex l s aqua azure black blue brightblack dark_aqua dark_blue dark_gray dark_green dark_pink dark_red dark_yellow dummy emerald gray green lime magenta orange pastel_aqua pastel_blue pastel_gray pastel_green pastel_pink pastel_red pastel_yellow pink purple random random_bright red white yellow

Methods

add approach copy div equal_rgb equals merge mul nearly_equals normalize normalize_color_value one_color_to_hex set set_hsl set_rgba set_scalar set_style sub to_str to_str_hex to_str_rgb to_str_rgba tween_to with_b with_g with_opacity with_r

Constructors

constructor

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

  • Parameters

    • r: number

      赤色の含有量

    • g: number

      緑色の含有量

    • b: number

      青色の含有量

    • Optional opacity: number

      不透明度

    Returns Color

  • new Color(color?): Color

  • Parameters

    • Optional color: string | number | Color

      色 ( "#ffffff" のような文字列や Color インスタンス等を指定できる )

    Returns Color

Properties

b

b: number

青色の含有量 0 ~ COLOR_MAX

g

g: number

緑色の含有量 0 ~ COLOR_MAX

opacity

opacity: number

不透明度 0 ~ 1

r

r: number

赤色の含有量 0 ~ COLOR_MAX

Accessors

h

hex

l

s

Static aqua

Static azure

Static black

Static blue

Static brightblack

Static dark_aqua

Static dark_blue

Static dark_gray

Static dark_green

Static dark_pink

Static dark_red

Static dark_yellow

Static dummy

Static emerald

Static gray

Static green

Static lime

Static magenta

Static orange

Static pastel_aqua

Static pastel_blue

Static pastel_gray

Static pastel_green

Static pastel_pink

Static pastel_red

Static pastel_yellow

Static pink

Static purple

Static random

Static random_bright

  • get random_bright(): Color

  • ランダムで綺麗な色を取得する

    Returns Color

    特定のあまりきれいではない色を排除したランダムな色を取得する

Static red

Static white

Static yellow

Methods

add

  • add(other): Color

  • 現在の色に特定の色かスカラーを加算した色を取得する

    Parameters

    • other: number | Color

      加算する色か、数値 ( 数値を指定した場合は r, g, b それぞれに数値を加算する )

    Returns Color

    指定されたかスカラーを加算した色

approach

  • approach(target_color, max_adjustment_color_value): Color

  • 指定された色に近づけた色を取得する

    Parameters

    • target_color: Color

      目標とする色

    • max_adjustment_color_value: number

      各色の要素を目標の色に近づける最大値

    Returns Color

    現在の色を目標の色に指定された分だけ近づけた色

copy

div

  • div(other): Color

  • 現在の色に特定のスカラーを除算した色を取得する

    Parameters

    • other: number

      除算する数値

    Returns Color

    指定された数値を除算した色

equal_rgb

  • equal_rgb(other): boolean

  • RGB 値だけが完全に同じかどうかを比較する

    Parameters

    • other: Color

      比較対象の色

    Returns boolean

    RGB 値だけが完全に同じ場合は true

equals

  • equals(other): boolean

  • 色が完全に同じかどうかを比較する

    Parameters

    • other: Color

      比較対象の色

    Returns boolean

    完全に同じ色の場合は true

merge

  • merge(...others): Color

  • 複数の色を混ぜ合わせる

    Parameters

    • Rest ...others: number[] | string[] | Color[]

      混ぜ合わせる色を指定する ( 可変長引数 )

    Returns Color

    指定された色を全て混ぜ合わせた色

mul

  • mul(other): Color

  • 現在の色に特定のスカラーを乗算した色を取得する

    Parameters

    • other: number

      乗算する数値

    Returns Color

    指定された数値を乗算した色

nearly_equals

  • nearly_equals(other, tolerance?): boolean

  • 似た色かどうかを比較する ( 不透明度は考慮しない )

    Parameters

    • other: Color

      比較対象の色

    • tolerance: number = ...

      同じ色とみなす誤差の閾値

    Returns boolean

    似た色なら true

normalize

  • normalize(): Color

  • 現在の値をとりえる範囲内の値に正規化する

    Returns Color

    r, g, b, a の全ての値を本来とりえる範囲内の値に正規化する

normalize_color_value

  • normalize_color_value(color_value): number

  • 一つの値を色がとりえる範囲内の値に正規化する

    Parameters

    • color_value: number

      色の要素の値

    Returns number

    0 ~ COLOR_MAX の間で正規化する

one_color_to_hex

  • one_color_to_hex(color_value): string

  • 0 ~ 255 の数字を 16 進数の文字列に変換する

    Parameters

    • color_value: number

      0 ~ 255 の整数

    Returns string

    16 進数に変換された 2 文字の文字列

set

  • set(r, g?, b?, opacity?): Color

  • 色を指定して初期化する

    Parameters

    • r: string | number | Color

      赤色の含有量 ( "#ffffff" のような文字列や Color インスタンス等を指定して g, b に null を渡しても初期化できる )

    • Optional g: number

      緑色の含有量

    • Optional b: number

      青色の含有量

    • opacity: number = 1

      不透明度

    Returns Color

    自身のインスタンス

set_hsl

  • set_hsl(h, s, l): Color

  • HLS 色空間を指定して色を設定する

    Parameters

    • h: number

      色相

    • s: number

      彩度

    • l: number

      輝度

    Returns Color

    自身のインスタンス

set_rgba

  • set_rgba(r, g, b, opacity): Color

  • RGBA 値を指定して色を設定する

    Parameters

    • r: number

      赤色の含有量

    • g: number

      緑色の含有量

    • b: number

      青色の含有量

    • opacity: null | number

      不透明度

    Returns Color

    自身のインスタンス

set_scalar

  • set_scalar(scalar): Color

  • 一つの値をで r, g, b を設定する

    Parameters

    • scalar: number

      0 ~ COLOR_MAX の値

    Returns Color

    指定された値を r, g, b に代入した自身のインスタンス

set_style

  • set_style(style): Color

  • 色を文字列で初期化する 対応している形式▽ rgb(255, 0, 0) rgba(255, 0, 0, 0.5) rgb(100%, 0%, 0%) rgba(100%, 0%, 0%, 0.5) hsl(120, 50, 50) hsla(120, 50, 50, 0.5) hsl(120, 50%, 50%) hsla(120, 50%, 50%, 0.5) #ff0 #ff0000

    Parameters

    • style: string

      特定の色を表す文字列

    Returns Color

    指定された色で初期化された自身のインスタンス

sub

  • sub(other): Color

  • 現在の色に特定の色かスカラーを減算した色を取得する

    Parameters

    • other: number | Color

      減算する色か、数値 ( 数値を指定した場合は r, g, b それぞれの数値から減算する )

    Returns Color

    指定された色かスカラーを減算した色

to_str

  • to_str(): string

  • 現在の色を一般的に色を表す文字列に変換する

    Returns string

    16 進数のカラーコードに変換した文字列

to_str_hex

  • to_str_hex(): string

  • 現在の色を 16 進数のカラーコードに変換する

    Returns string

    16 進数のカラーコードに変換した文字列

to_str_rgb

  • to_str_rgb(): string

  • 現在の色を rgb(50, 100, 150) 形式の文字列に変換して取得する

    Returns string

    rgb(50, 100, 150) 形式の文字列

to_str_rgba

  • to_str_rgba(): string

  • 現在の色を rgba(50, 100, 150, 0.5) 形式の文字列に変換して取得する

    Returns string

    rgba(50, 100, 150, 0.5) 形式の文字列

tween_to

  • tween_to(dest, duration): void

  • 指定された時間で指定された色に変化するアニメーションを設定する

    Parameters

    • dest: Color

      目標とする色

    • duration: number

      アニメーションの時間 ( 秒 )

    Returns void

with_b

  • with_b(b): Color

  • B だけを変更した Color を取得する

    Parameters

    • b: number

      青色の含有量

    Returns Color

    青色の含有量だけを変更した Color インスタンス

with_g

  • with_g(g): Color

  • G だけを変更した Color を取得する

    Parameters

    • g: number

      緑色の含有量

    Returns Color

    緑色の含有量だけを変更した Color インスタンス

with_opacity

  • with_opacity(opacity): Color

  • 不透明度だけを変更した Color を取得する

    Parameters

    • opacity: number

      不透明度 ( 0 ~ 1 )

    Returns Color

    不透明度だけを変更した Color インスタンス

with_r

  • with_r(r): Color

  • R だけを変更した Color を取得する

    Parameters

    • r: number

      赤色の含有量

    Returns Color

    赤色の含有量だけを変更した Color インスタンス

Settings

Member Visibility

Theme

On This Page

constructorbgopacityrhhexlsaquaazureblackbluebrightblackdark_aquadark_bluedark_graydark_greendark_pinkdark_reddark_yellowdummyemeraldgraygreenlimemagentaorangepastel_aquapastel_bluepastel_graypastel_greenpastel_pinkpastel_redpastel_yellowpinkpurplerandomrandom_brightredwhiteyellowaddapproachcopydivequal_rgbequalsmergemulnearly_equalsnormalizenormalize_color_valueone_color_to_hexsetset_hslset_rgbaset_scalarset_stylesubto_strto_str_hexto_str_rgbto_str_rgbatween_towith_bwith_gwith_opacitywith_r