PaletteManager Class Reference

The PaletteManager JavaScript global object. Used to get information about the Colour view current selection. More...

Public Slots

String getCurrentColorId ()
 Gets the current colour Id from the ColourView. More...
 
String getCurrentColorName ()
 Gets the current colour name from the ColourView. More...
 
String getCurrentPaletteId ()
 Gets the current palette Id from the ColourView. More...
 
String getCurrentPaletteName ()
 Gets the current palette name from the ColourView. More...
 
String getCurrentPalettePath ()
 Gets the current palette path (including palette name) from the ColourView. More...
 
void setCurrentPaletteById (String palette)
 Sets the current palette in the ColourView. More...
 
void setCurrentColorById (String color)
 Sets the current colour in the ColourView. More...
 
void setCurrentPencilTextureById (String texture)
 
void setCurrentPaletteAndColorById (String palette, String color)
 Sets the current palette and colour in the ColourView. More...
 
int getCurrentPaletteSize ()
 Gets the length of the current palette in the ColourView. More...
 
String getColorName (int index)
 Gets the name of the colour in the currently selected palette. More...
 
String getColorId (int index)
 Gets the Id of the colour in the currently selected palette. More...
 
int getNumPalettes ()
 Gets number of palettes in the currently selected palette list in the ColourView list. More...
 
int getNumPalettes (bool scenePaletteList)
 Gets number of palettes in the palette list in the ColourView. More...
 
String getPaletteName (int index)
 Gets the name of the palette in the current palette list. More...
 
String getPaletteName (int index, bool scenePaletteList)
 Gets the name of the palette in the current palette list. More...
 
String getPalettePath (int index)
 Gets the path (including name) of the palette in the current palette list. More...
 
String getPalettePath (int index, bool scenePaletteList)
 Gets the path (including name) of the palette in the current palette list. More...
 
String getPaletteId (int index)
 Gets the Id of the palette in the current palette list. More...
 
String getPaletteId (int index, bool scenePaletteList)
 Gets the Id of the palette in the current palette list. More...
 
void applyColorSelection ()
 Applies the current colour selection to the current drawing selection. More...
 

Detailed Description

The PaletteManager JavaScript global object. Used to get information about the Colour view current selection.

An example of how to use the palette override attributes of the colour override node, using the PaletteManager:

Available attributes for getTextAttr:

  • PALETTES.NUMBER - returns the number of palettes in the palette override list
  • PALETTES.x, where x is a palette index - return the palette name (path) of the palette at index x (x >= 0)
  • If no x, or it's invalid, assume a value of 0

    Available attributes for setTextAttr:

    • PALETTES.CLEAR - clear the palette override list
    • PALETTES.ADD "palette_path" - add the palette with full path name to the palette override list. Can supply the full path or get from PaletteManager.getPalettePath(), PaletteManager.getCurrentPalettePath()
    • PALETTES.REMOVE "palette_path" - remove a palette. Can supply the full path or get from getTextAttr("node_path", atFrame, "PALETTES.x")

    Note that the frame number argument (to node.getTextAttr() and node.setTextAttr()) is unused, and the attribute value in "PALETTES.CLEAR" is unused.

    function paletteOverrideExample()
    {
    return;
    // not strictly necessary, depends on whether each setTextAttr() call should be undoable individually
    scene.beginUndoRedoAccum("Palette Overrides");
    // return the number of palettes in the palette override list
    var num = node.getTextAttr(node, 1, "PALETTES.NUMBER");
    // return the first (top-most) palette name in the palette override list (will be "" if the list is empty).
    // note that no palette number is supplied in this example, so 0 is assumed (equivalent to "PALETTES.0")
    var palette = node.getTextAttr(node, 1, "PALETTES");
    // clear (empty) the list
    node.setTextAttr(node, "PALETTES.CLEAR", 1, "");
    // should be 0
    num = node.getTextAttr(node, 1, "PALETTES.NUMBER");
    // add a palette to the palette override list
    node.setTextAttr(node, "PALETTES.ADD", 1, curpath);
    // can also specify a full path for the palette
    // node.setTextAttr(node, "PALETTES.ADD", 1, "/usadata000/.../example.plt");
    // return the first two palette names (we added one, so one should be non-empty)
    palette = node.getTextAttr(node, 1, "PALETTES.0");
    // this one should be "", only one in the list
    var palette1 = node.getTextAttr(node, 1, "PALETTES.1");
    // return the name of the last palette that we added
    num = node.getTextAttr(node, 1, "PALETTES.NUMBER");
    var index = parseInt(num);
    index--;
    var attr = "PALETTES." + index;
    palette = node.getTextAttr(node, 1, attr);
    // remove one from the list
    node.setTextAttr(node, "PALETTES.REMOVE", 1, palette);
    num = node.getTextAttr(node, 1, "PALETTES.NUMBER");
    }

Member Function Documentation

◆ applyColorSelection

void PaletteManager::applyColorSelection ( )
slot

Applies the current colour selection to the current drawing selection.

◆ getColorId

String PaletteManager::getColorId ( int  index)
slot

Gets the Id of the colour in the currently selected palette.

Parameters
index: Index of colour in palette.
Returns
Returns the Id of the colour in the currently selected palette.

◆ getColorName

String PaletteManager::getColorName ( int  index)
slot

Gets the name of the colour in the currently selected palette.

Parameters
index: Index of colour in palette.
Returns
Returns the name of the colour in the currently selected palette.

◆ getCurrentColorId

String PaletteManager::getCurrentColorId ( )
slot

Gets the current colour Id from the ColourView.

Returns
Returns the current colour Id from the ColourView.

◆ getCurrentColorName

String PaletteManager::getCurrentColorName ( )
slot

Gets the current colour name from the ColourView.

Returns
Returns the current colour name from the ColourView.

◆ getCurrentPaletteId

String PaletteManager::getCurrentPaletteId ( )
slot

Gets the current palette Id from the ColourView.

Returns
Returns the current palette Id from the ColourView.

◆ getCurrentPaletteName

String PaletteManager::getCurrentPaletteName ( )
slot

Gets the current palette name from the ColourView.

Returns
Returns the current palette name from the ColourView.

◆ getCurrentPalettePath

String PaletteManager::getCurrentPalettePath ( )
slot

Gets the current palette path (including palette name) from the ColourView.

Returns
Returns the current palette path (including palette name) from the ColourView.

◆ getCurrentPaletteSize

int PaletteManager::getCurrentPaletteSize ( )
slot

Gets the length of the current palette in the ColourView.

Returns
Returns the length of the current palette in the ColourView.

◆ getNumPalettes [1/2]

int PaletteManager::getNumPalettes ( )
slot

Gets number of palettes in the currently selected palette list in the ColourView list.

Returns
Returns the number of palettes in the currently selected palette list in the ColourView list.

◆ getNumPalettes [2/2]

int PaletteManager::getNumPalettes ( bool  scenePaletteList)
slot

Gets number of palettes in the palette list in the ColourView.

Parameters
scenePaletteList: Whether to check scene palette list or element palette list.
Returns
Returns the number of palettes in the palette list in the ColourView.

◆ getPaletteId [1/2]

String PaletteManager::getPaletteId ( int  index)
slot

Gets the Id of the palette in the current palette list.

Parameters
index: Index of palette within palette list.
Returns
Returns the Id of the palette in the current palette list.

◆ getPaletteId [2/2]

String PaletteManager::getPaletteId ( int  index,
bool  scenePaletteList 
)
slot

Gets the Id of the palette in the current palette list.

Parameters
index: Index of palette within palette list.
scenePaletteList: Whether to check scene palette list or element palette list.
Returns
Returns the Id of the palette in the current palette list.

◆ getPaletteName [1/2]

String PaletteManager::getPaletteName ( int  index)
slot

Gets the name of the palette in the current palette list.

Parameters
index: Index of palette within palette list.
Returns
Returns the name of the palette in the current palette list.

◆ getPaletteName [2/2]

String PaletteManager::getPaletteName ( int  index,
bool  scenePaletteList 
)
slot

Gets the name of the palette in the current palette list.

Parameters
index: Index of palette within palette list.
scenePaletteList: Whether to check scene palette list or element palette list.
Returns
Returns the name of the palette in the current palette list.

◆ getPalettePath [1/2]

String PaletteManager::getPalettePath ( int  index)
slot

Gets the path (including name) of the palette in the current palette list.

Parameters
index: Index of palette within palette list
Returns
Returns the path (including name) of the palette in the current palette list.

◆ getPalettePath [2/2]

String PaletteManager::getPalettePath ( int  index,
bool  scenePaletteList 
)
slot

Gets the path (including name) of the palette in the current palette list.

Parameters
index: Index of palette within palette list.
scenePaletteList: Whether to check scene palette list or element palette list.
Returns
Returns the path (including name) of the palette in the current palette list.

◆ setCurrentColorById

void PaletteManager::setCurrentColorById ( String  color)
slot

Sets the current colour in the ColourView.

Parameters
color: Id of colour.

◆ setCurrentPaletteAndColorById

void PaletteManager::setCurrentPaletteAndColorById ( String  palette,
String  color 
)
slot

Sets the current palette and colour in the ColourView.

Parameters
palette: Palette Id.
color: Colour Id.

◆ setCurrentPaletteById

void PaletteManager::setCurrentPaletteById ( String  palette)
slot

Sets the current palette in the ColourView.

Parameters
palette: Id of palette.

◆ setCurrentPencilTextureById

void PaletteManager::setCurrentPencilTextureById ( String  texture)
slot