Defines an interface for the colour override node. More...

#include <coloroverrideinterface.h>

Inheritance diagram for ColorOverride:

Collaboration diagram for ColorOverride:

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 Colour 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

Defines an interface for the colour override node.

Member Function Documentation

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

void ColorOverride::clearPalettes ( )

slot

Clear the list of whole palette overrides.

int ColorOverride::getNumColorOverrides ( )

slot

Returns the number of individual colour overrides.

int ColorOverride::getNumPalettes ( )

slot

Returns the number of whole palette overrides.

int ColorOverride::getNumSelectedColors ( )

slot

Returns the number of selected colours.

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

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

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

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

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

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

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

Applies for one of the modes that references a texture

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

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

The documentation for this class was generated from the following file:

dox_files/objectScript/coloroverrideinterface.h

Public Slots

Detailed Description

Member Function Documentation