classes-Com-Tecnick-Color-Model-Hsl

It appears that you are using AdBlocking software. The cost of running this website is covered by advertisements. If you like it please feel free to a small amount of money to secure the future of this website.

Hsl extends Model implements Template

Com\Tecnick\Color\Model\Hsl

HSL Color Model class

Tags
since
2015-02-21
category

Library

author

Nicola Asuni info@tecnick.com

copyright

2015-2015 Nicola Asuni - Tecnick.com LTD

license

http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)

link
https://github.com/tecnickcom/tc-lib-color

Interfaces, Classes and Traits

Template
Com\Tecnick\Color\Model\Template

Table of Contents

$cmp_alpha  : float
Value of the Alpha channel component.
$cmp_hue  : float
Value of the Hue color component [0..1]
$cmp_lightness  : float
Value of the Lightness color component [0..1]
$cmp_saturation  : float
Value of the Saturation color component [0..1]
$type  : string
Color Model type
__construct()  : mixed
Initialize a new color object
getArray()  : array<string|int, mixed>
Get an array with all color components
getComponentsString()  : string
Get a space separated string with color component values.
getCssColor()  : string
Get the CSS representation of the color: hsla(H, S, L, A) NOTE: Supported since CSS3 and above.
getHexValue()  : int
Get the normalized hexadecimal value of the specified float fraction
getJsPdfColor()  : string
Get the color format used in Acrobat JavaScript NOTE: the alpha channel is omitted from this representation unless is 0 = transparent
getNormalizedArray()  : array<string|int, mixed>
Get an array with color components values normalized between 0 and $max.
getNormalizedValue()  : int
Get the normalized integer value of the specified float fraction
getPdfColor()  : string
Get the color components format used in PDF documents (RGB) NOTE: the alpha channel is omitted
getRgbaHexColor()  : string
Get the Hexadecimal representation of the color with alpha channel: #RRGGBBAA
getRgbHexColor()  : string
Get the Hexadecimal representation of the color: #RRGGBB
getType()  : string
Get the color model type (GRAY, RGB, HSL, CMYK)
invertColor()  : mixed
Invert the color
toCmykArray()  : array<string|int, mixed>
Get an array with CMYK color components
toGrayArray()  : array<string|int, mixed>
Get an array with Gray color components
toHslArray()  : array<string|int, mixed>
Get an array with HSL color components
toRgbArray()  : array<string|int, mixed>
Get an array with RGB color components
convertHuetoRgb()  : float
Convet Hue to RGB

Properties

$cmp_alpha

Value of the Alpha channel component.

protected float $cmp_alpha = 1.0

Values range between 0.0 (fully transparent) and 1.0 (fully opaque)

$cmp_hue

Value of the Hue color component [0..1]

protected float $cmp_hue = 0.0

$cmp_lightness

Value of the Lightness color component [0..1]

protected float $cmp_lightness = 0.0

$cmp_saturation

Value of the Saturation color component [0..1]

protected float $cmp_saturation = 0.0

$type

Color Model type

protected string $type = 'HSL'

Methods

__construct()

Initialize a new color object

public __construct(array<string|int, mixed> $components) : mixed
Parameters
$components : array<string|int, mixed>

Array of color components is the range [0..1]

Return values
mixed

getArray()

Get an array with all color components

public getArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

with keys ('H', 'S', 'L', 'A')

getComponentsString()

Get a space separated string with color component values.

public getComponentsString() : string
Return values
string

getCssColor()

Get the CSS representation of the color: hsla(H, S, L, A) NOTE: Supported since CSS3 and above.

public getCssColor() : string

Use getHexadecimalColor() for CSS1 and CSS2

Return values
string

getHexValue()

Get the normalized hexadecimal value of the specified float fraction

public getHexValue(float $value, int $max) : int
Parameters
$value : float

Fraction value to convert [0..1]

$max : int

Maximum value to return (reference value)

Return values
int

value [0..$max]

getJsPdfColor()

Get the color format used in Acrobat JavaScript NOTE: the alpha channel is omitted from this representation unless is 0 = transparent

public getJsPdfColor() : string
Return values
string

getNormalizedArray()

Get an array with color components values normalized between 0 and $max.

public getNormalizedArray(int $max) : array<string|int, mixed>

NOTE: the alpha and other fraction component values are kept in the [0..1] range.

Parameters
$max : int

Maximum value to return (it is always set to 360)

Return values
array<string|int, mixed>

with keys ('H', 'S', 'L', 'A')

getNormalizedValue()

Get the normalized integer value of the specified float fraction

public getNormalizedValue(float $value, int $max) : int
Parameters
$value : float

Fraction value to convert [0..1]

$max : int

Maximum value to return (reference value)

Return values
int

value [0..$max]

getPdfColor()

Get the color components format used in PDF documents (RGB) NOTE: the alpha channel is omitted

public getPdfColor([bool $stroke = false ]) : string
Parameters
$stroke : bool = false

True for stroking (lines, drawing) and false for non-stroking (text and area filling).

Return values
string

getRgbaHexColor()

Get the Hexadecimal representation of the color with alpha channel: #RRGGBBAA

public getRgbaHexColor() : string
Return values
string

getRgbHexColor()

Get the Hexadecimal representation of the color: #RRGGBB

public getRgbHexColor() : string
Return values
string

getType()

Get the color model type (GRAY, RGB, HSL, CMYK)

public getType() : string
Return values
string

invertColor()

Invert the color

public invertColor() : mixed
Return values
mixed

toCmykArray()

Get an array with CMYK color components

public toCmykArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

with keys ('cyan', 'magenta', 'yellow', 'key', 'alpha')

toGrayArray()

Get an array with Gray color components

public toGrayArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

with keys ('gray')

toHslArray()

Get an array with HSL color components

public toHslArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

with keys ('hue', 'saturation', 'lightness', 'alpha')

toRgbArray()

Get an array with RGB color components

public toRgbArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

with keys ('red', 'green', 'blue', 'alpha')

convertHuetoRgb()

Convet Hue to RGB

private convertHuetoRgb(float $vala, float $valb, float $hue) : float
Parameters
$vala : float

Temporary value A

$valb : float

Temporary value B

$hue : float

Hue value

Return values
float
 

© 2004-2021 – Nicola Asuni - Tecnick.com - All rights reserved.
about - disclaimer - privacy