The JavaScript class for manipulating colour override nodes. Created from the node global object. More...

Public Slots
Whole Palette Overrides.
int	getNumPalettes ()
	Returns the number of whole palette overrides. More...

String	palettePath (int index)
	Returns the full path (including name and extension) of the palette override at postion 'index'. More...

void	setPalettePath (int index, String &path)
	Set the path (including name and extension) of the palette at position 'index'. More...

void	clearPalettes ()
	Clear the list of whole palette overrides. More...

void	addPalette (String &path)
	Add a full palette path at the bottom of the list of whole palette overrides. More...

void	removePalette (String &path)
	Remove a palette with the supplied path from the list of whole palette overrides. More...

Individual Color Overrides.
int	getNumColorOverrides ()
	Returns the number of individual colour overrides. More...

String	getOverrideTexturePath (int index)
	Returns the path of a texture file for the colour override at the specified position in the list. More...

void	setOverrideTexturePath (int index, String &path)
	Sets the path of a texture file for the colour override at the specified position in the list. More...

String	getOverridePalettePath (int index)
	Returns the full path (including name and extension) of the palette to which the override colour belongs. More...

void	setOverridePalettePath (int index, String &path)
	Sets the full path (including name and extension) of the palette to which the override colour belongs. More...

Render Selected Colours Only.
int	getNumSelectedColors ()
	Returns the number of selected colours. More...

String	getSelectedPalettePath (int index)
	Returns the full path (including name and extension) of the palette to which the selected colour belongs. More...

void	setSelectedPalettePath (int index, String &path)
	Sets the full path (including name and extension) of the palette to which the selected colour belongs. More...

Detailed Description

The JavaScript class for manipulating colour override nodes. Created from the node global object.

Used to get information about palettes associated to a colour override node, or to add or remove a palette from the node.

var myColorOverride = node.getColorOverride("Top/MyColorOverrideNode");

Member Function Documentation

◆ addPalette

void ColorOverride::addPalette ( String & path )

slot

Add a full palette path at the bottom of the list of whole palette overrides.

Parameters

path	: Path of this new palette override.

◆ clearPalettes

void ColorOverride::clearPalettes ( )

slot

Clear the list of whole palette overrides.

◆ getNumColorOverrides

int ColorOverride::getNumColorOverrides ( )

slot

Returns the number of individual colour overrides.

Returns: Returns the number of individual colour overrides.

◆ getNumPalettes

int ColorOverride::getNumPalettes ( )

slot

Returns the number of whole palette overrides.

◆ getNumSelectedColors

int ColorOverride::getNumSelectedColors ( )

slot

Returns the number of selected colours.

Returns: Returns the number of selected colours.

◆ getOverridePalettePath

String ColorOverride::getOverridePalettePath ( int index )

slot

Returns the full path (including name and extension) of the palette to which the override colour belongs.

Parameters

index : Index in the list of individual colour overrides.

Returns: Returns the full path (including name and extension) of the palette to which the override colour belongs.

◆ getOverrideTexturePath

String ColorOverride::getOverrideTexturePath ( int index )

slot

Returns the path of a texture file for the colour override at the specified position in the list.

Parameters

index : Index in the list of individual colour overrides. Applies for one of the modes that references a texture.

Returns: Returns the path of a texture file for the colour override at the specified position in the list.

◆ getSelectedPalettePath

String ColorOverride::getSelectedPalettePath ( int index )

slot

Returns the full path (including name and extension) of the palette to which the selected colour belongs.

Parameters

index : Index in the list of selected colours.

Returns: Returns the full path (including name and extension) of the palette to which the selected colour belongs.

◆ palettePath

String ColorOverride::palettePath ( int index )

slot

Returns the full path (including name and extension) of the palette override at postion 'index'.

Parameters

index : Index of the palette in the list of palette overrides.

◆ removePalette

void ColorOverride::removePalette ( String & path )

slot

Remove a palette with the supplied path from the list of whole palette overrides.

Parameters

path	: Path of this palette to remove.

◆ setOverridePalettePath

void ColorOverride::setOverridePalettePath	(	int	index,
		String &	path
	)

slot

Sets the full path (including name and extension) of the palette to which the override colour belongs.

Parameters

index	: Index in the list of individual colour overrides.
path	: New path for the palette.

◆ setOverrideTexturePath

void ColorOverride::setOverrideTexturePath	(	int	index,
		String &	path
	)

slot

Sets the path of a texture file for the colour override at the specified position in the list.

Parameters

index	: Index in the list of individual colour overrides.
path	: Texture path.

Applies for one of the modes that references a texture.

◆ setPalettePath

void ColorOverride::setPalettePath	(	int	index,
		String &	path
	)

slot

Set the path (including name and extension) of the palette at position 'index'.

Parameters

index	: Index of the palette in the list of palette overrides.
path	: New path of this palette override.

◆ setSelectedPalettePath

void ColorOverride::setSelectedPalettePath	(	int	index,
		String &	path
	)

slot

Sets the full path (including name and extension) of the palette to which the selected colour belongs.

Parameters

index	: Index in the list of selected colours.
path	: New path for the palette.

Public Slots

Detailed Description

Member Function Documentation

◆ addPalette

◆ clearPalettes

◆ getNumColorOverrides

◆ getNumPalettes

◆ getNumSelectedColors

◆ getOverridePalettePath

◆ getOverrideTexturePath

◆ getSelectedPalettePath

◆ palettePath

◆ removePalette

◆ setOverridePalettePath

◆ setOverrideTexturePath

◆ setPalettePath

◆ setSelectedPalettePath