Detailed Description

Represents and provides methods to create and access Palette objects from the current project.

Behaves as a container list for Palette object types.

The project's PaletteList can be accessed via OMC::Project.palettes.

A Simple Example - Removing all the current scene palettes, creating new palettes and list their names.

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
# Clear the scene of palettes:
scenePalettesWereCleared = palette_list.clear()
# Create a new colour Palette:
new_palette_type = 'Colour'
new_palette_name = 'Colour_Palette_Name'
new_colour_palette = palette_list.create(new_palette_type,new_palette_name)
# Create a new pencil texture:
new_palette_type = 'Pencil Texture'
new_palette_name = 'Pencil_Texture_Palette_Name'
new_pencil_texture_palette = palette_list.create(new_palette_type,new_palette_name)
# Display list contents names:
print(palette_list.palette_names()) #['Colour_Palette_Name', 'Pencil_Texture_Palette_Name']

Public Member Functions
bool	contains (OMC::Palette *palette)
	Checks if the list contains a given Palette object. More...

Array [OMC::Palette *]	list ()
	Converts the dynamic list into a concrete list of Palette objects. More...

Array [QString]	palette_names ()
	Lists the Palette objects names. More...

OMC::Palette *	create (QString paletteType="", QString name="", bool overwrite=False, unsigned int index=-1, QString specifiedPath="")
	Creates a new Palette on this PaletteList at the position specified by 'index'. creations at index -1, will be at the back of the paletteList. More...

void	remove (OMC::Palette *palette)
	Remove the palette provided as an argument. Throws error if unsuccessful. More...

OMC::Palette *	duplicate (OMC::Palette *palette, QString name="")
	Duplicates an existing Palette object and inserts it to the back of this PaletteList. More...

OMC::Palette *	clone (OMC::Palette *palette, QString name="")
	Clones an existing Palette object and inserts it to the back of this PaletteList. The cloned Palette will share the same id as the source Palette, although they'll have different system paths. More...

void	reorder (OMC::Palette *palette, int index)
	Reorders the internal list by moving a the specified Palette item to the given index. Throws error if unsuccessful. More...

void	move_palette_up (OMC::Palette *palette)
	Moves the Palette up one index. Throws error if unsuccessful. More...

void	move_palette_down (OMC::Palette *palette)
	Moves the Palette down one index. Throws error if unsuccessful. More...

void	clear ()
	Clears the PaletteList and deletes them from the system. Throws error if unsuccessful. More...

OMC::Palette *	find (QString palette_id, bool lookInLinkedPalettes)
	Finds the Palette object on the list with the given 'palette_id'. More...

OMC::Palette *	palette_containing_colour (OMC::PaletteBaseColour *colour)
	Finds the Palette, within the PaletteList, which contains the given color object or color ID. More...

OMC::Element *	element ()
	Retrieves the element object that owns the PaletteList, if the PaletteList is stored in an element. More...

void	lock ()
	Try to obtain the database lock. The lock will be held until it is released in script or the ui. Safe to call multiple time to get the lock state. Throws error if unsuccessful. More...

void	release ()
	Try to release the database lock. Release access to the Palette. Other users will be able to obtain the access rights to the Palette. Throws error if unsuccessful. More...

Public Attributes
OMC::Palette *	operator[int index]
	Provides the Palette object at the given index. More...

QString	path
	The path to the PaletteList on disk. More...

bool	valid
	True if the PaletteList object is valid. More...

bool	loaded
	Identifies if the PaletteList was successfully loaded from the disk. More...

QString	id
	The PaletteList ID of this PaletteList. More...

QString	type
	The type of PaletteList, coudl either be Colour or Pencil Texture. More...

int	element_id
	The element id in which the Palette is stored if location is ELEMENT. Returns None if the Palette is not stored in an element. More...

bool	locked
	Whether the Palette locked is currently locked for modifications. More...

Member Function Documentation

◆ clear()

void OMC::PaletteList::clear ( )

Clears the PaletteList and deletes them from the system. Throws error if unsuccessful.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
# Clear the paletteList of palettes
palette_list.clear()
# Create new Palettes:
palette_type = 'Colour'
palette_a = palette_list.create(palette_type,"A")
palette_b = palette_list.create(palette_type,"B")
palette_c = palette_list.create(palette_type,"C")
print(palette_list.palette_names())
#['A', 'B', 'C']
# Clear the list
palette_list.clear()
print(palette_list.palette_names())
#[]

◆ clone()

OMC::Palette* OMC::PaletteList::clone	(	OMC::Palette *	palette,
		QString	name = `""`
	)

Clones an existing Palette object and inserts it to the back of this PaletteList. The cloned Palette will share the same id as the source Palette, although they'll have different system paths.

Returns: Returns the cloned Palette, already inserted on the PaletteList.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
# Create a new Palette:
new_palette_type = 'Colour'
new_palette = palette_list.create(new_palette_type) # Created with a 'Default' colour.
# Add contents
colour_a = new_palette.create_solid_colour("A") # Added at index 1.
colour_b = new_palette.create_solid_colour("B") # Added at index 2.
# Clone
new_palette_name = "Cloned_Palette"
new_cloned_palette = palette_list.clone(new_palette,new_palette_name)
# Check IDs
if new_cloned_palette.id != new_palette.id:
  print("Palettes have different IDs, even though they were cloned.")
# Check contents
if new_cloned_palette.size() == new_palette.size() and \
   new_cloned_palette[0].name == 'Default' and \
   new_cloned_palette[1].name == colour_a.name and \
   new_cloned_palette[2].name == colour_b.name:
  print("Palettes have the same contents.")
if new_cloned_palette[1].id == colour_a.id and \
   new_cloned_palette[2].id == colour_b.id:
  print("Contained colors have the same IDs.") # Changes to colours on the original palette will take effect on the clone.

◆ contains()

bool OMC::PaletteList::contains ( OMC::Palette * palette )

Checks if the list contains a given Palette object.

Returns: True if contains the Palette.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes
if palette_list.size() != 0:
  aPalette = palette_list[0]
  print(palette_list.contains(aPalette)) # True

◆ create()

OMC::Palette* OMC::PaletteList::create	(	QString	paletteType = `""`,
		QString	name = `""`,
		bool	overwrite = `False`,
		unsigned int	index = `-1`,
		QString	specifiedPath = `""`
	)

Creates a new Palette on this PaletteList at the position specified by 'index'. creations at index -1, will be at the back of the paletteList.

Returns: The created Palette object, already inserted on the list, otherwise throws error.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
# Create a new colour Palette:
new_palette_type = 'Colour'
new_palette_name = 'Colour_Palette_Name'
overwrite = True # overwrite in file system
insertion_index = 0
new_colour_palette = palette_list.create(new_palette_type,new_palette_name,overwrite,insertion_index)
print(new_colour_palette) # Palette(...)[...]
print(new_colour_palette.id == palette_list[insertion_index].id) # True

◆ duplicate()

OMC::Palette* OMC::PaletteList::duplicate	(	OMC::Palette *	palette,
		QString	name = `""`
	)

Duplicates an existing Palette object and inserts it to the back of this PaletteList.

Returns: Returns the duplicated Palette, already inserted on the PaletteList.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
# Create a new Palette:
new_palette_type = 'Colour'
new_palette = palette_list.create(new_palette_type) # Created with a 'Default' colour.
# Add contents
colour_a = new_palette.create_solid_colour("A") # Added at index 1.
colour_b = new_palette.create_solid_colour("B") # Added at index 2.
# Duplicate
new_palette_name = "Duplicated_Palette"
new_duplicated_palette = palette_list.duplicate(new_palette,new_palette_name)
# Check IDs
if new_duplicated_palette.id != new_palette.id:
  print("Palettes have different IDs.")
# Check contents
if new_duplicated_palette.size() == new_palette.size() and \
   new_duplicated_palette[0].name == 'Default' and \
   new_duplicated_palette[1].name == colour_a.name and \
   new_duplicated_palette[2].name == colour_b.name:
  print("Palettes have the same contents.")
if new_duplicated_palette[1].id != colour_a.id and \
   new_duplicated_palette[2].id != colour_b.id:
  print("Created colors have new IDs.")

◆ element()

OMC::Element* OMC::PaletteList::element ( )

Retrieves the element object that owns the PaletteList, if the PaletteList is stored in an element.

Returns: Returns the element object on which this PaletteList is stored

Example:

from ToonBoom import harmony
palette_lists = harmony.session().project.palette_lists;
scene_palette_list = harmony.session().project.palettes;
print(scene_palette_list.element() == None) #True, since the paletteList's from the scene are not from elements
for palette_list in palette_lists:
  if palette_list.id != scene_palette_list.id:
    print("I am a paletteList from an element with id: ",palette_list.element().id)

◆ find()

OMC::Palette* OMC::PaletteList::find	(	QString	palette_id,
		bool	lookInLinkedPalettes
	)

Finds the Palette object on the list with the given 'palette_id'.

Parameters

lookInLinkedPalettes : whether to look in other accessible palettes, typically the scene PaletteList when searching from an element PaletteList.

Returns: Returns the found Palette object, or throws error.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
# Create a new Palette:
palette_type = 'Colour'
new_palette = palette_list.create(palette_type,"A",True)
# Find Palette
new_palette_found = palette_list.find(new_palette.id,False)
# Found Palette is identical
print(new_palette_found.id == new_palette.id) #True
print(new_palette_found.name == new_palette.name) #True

◆ list()

Array [OMC::Palette*] OMC::PaletteList::list ( )

Converts the dynamic list into a concrete list of Palette objects.

Returns: Returns a list of the Palette objects.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes
for palette in palette_list.list():
  print(palette) # Palette(...)[...]

◆ lock()

void OMC::PaletteList::lock ( )

Try to obtain the database lock. The lock will be held until it is released in script or the ui. Safe to call multiple time to get the lock state. Throws error if unsuccessful.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
#Lock PaletteList
palette_list.lock()
#Check that it's locked
print(palette_list.locked == True) # True
#Release lock
palette_list.release()
print(palette_list.locked == False) # True

◆ move_palette_down()

void OMC::PaletteList::move_palette_down ( OMC::Palette * palette )

Moves the Palette down one index. Throws error if unsuccessful.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
# Clear the paletteList of palettes
palette_list.clear()
# Create new Palettes:
palette_type = 'Colour'
palette_a = palette_list.create(palette_type,"A")
palette_b = palette_list.create(palette_type,"B")
palette_c = palette_list.create(palette_type,"C")
print(palette_list.palette_names())
#['A', 'B', 'C']
# Move the palette down on the list
palette_list.move_palette_down(palette_b)
print(palette_list.palette_names())
#['B', 'A', 'C']

◆ move_palette_up()

void OMC::PaletteList::move_palette_up ( OMC::Palette * palette )

Moves the Palette up one index. Throws error if unsuccessful.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
# Clear the paletteList of palettes
palette_list.clear()
# Create new Palettes:
palette_type = 'Colour'
palette_a = palette_list.create(palette_type,"A")
palette_b = palette_list.create(palette_type,"B")
palette_c = palette_list.create(palette_type,"C")
print(palette_list.palette_names())
#['A', 'B', 'C']
# Move the palette up on the list
palette_list.move_palette_up(palette_b)
print(palette_list.palette_names())
#['A', 'C', 'B']

◆ palette_containing_colour()

OMC::Palette* OMC::PaletteList::palette_containing_colour ( OMC::PaletteBaseColour * colour )

Finds the Palette, within the PaletteList, which contains the given color object or color ID.

Returns: Returns the found Palette object, or throws error.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
# Clear the paletteList of palettes
palette_list.clear()
# Create new Palettes:
palette_type = 'Colour'
palette_a = palette_list.create(palette_type,"A")
palette_b = palette_list.create(palette_type,"B")
palette_c = palette_list.create(palette_type,"C")
# Create a specific Colour
colour_b = palette_b.create_solid_colour("b",[1,2,3,255])
# Find the palette by the Colour object (or its id)
palette_containing_b = palette_list.palette_containing_colour(colour_b)
# Find the original Palette
print(palette_containing_b.id == palette_b.id) #True
print(palette_containing_b.name == palette_b.name) #True

◆ palette_names()

Array [QString] OMC::PaletteList::palette_names ( )

Lists the Palette objects names.

Returns: Returns a string list of the names of the palettes.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes
for palette_name in palette_list.palette_names():
  print(palette_name) # The name of the palettes

◆ release()

void OMC::PaletteList::release ( )

Try to release the database lock. Release access to the Palette. Other users will be able to obtain the access rights to the Palette. Throws error if unsuccessful.

Examplified in lock() method.

◆ remove()

void OMC::PaletteList::remove ( OMC::Palette * palette )

Remove the palette provided as an argument. Throws error if unsuccessful.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
# Start monitoring the list size
list_initial_size = palette_list.size()
# Create a new Palette:
new_palette_type = 'Pencil Texture'
new_pencil_texture_palette = palette_list.create(new_palette_type)
# Size increase
if list_initial_size + 1 == palette_list.size():
  print("New palette inserted.")
# remove
palette_list.remove(new_pencil_texture_palette)
# Size increase
if list_initial_size == palette_list.size():
  print("Palette removed.")

◆ reorder()

void OMC::PaletteList::reorder	(	OMC::Palette *	palette,
		int	index
	)

Reorders the internal list by moving a the specified Palette item to the given index. Throws error if unsuccessful.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
# Clear the paletteList of palettes
palette_list.clear()
# Create new Palettes:
palette_type = 'Colour'
palette_a = palette_list.create(palette_type,"A")
palette_b = palette_list.create(palette_type,"B")
palette_c = palette_list.create(palette_type,"C")
print(palette_list.palette_names())
#['A', 'B', 'C']
# Move/reorder palettes on the list
palette_list.reorder(palette_c,0)
print(palette_list.palette_names())
#['C', 'A', 'B']

Member Data Documentation

◆ element_id

int OMC::PaletteList::element_id

read

The element id in which the Palette is stored if location is ELEMENT. Returns None if the Palette is not stored in an element.

◆ id

QString OMC::PaletteList::id

read

The PaletteList ID of this PaletteList.

◆ loaded

bool OMC::PaletteList::loaded

read

Identifies if the PaletteList was successfully loaded from the disk.

◆ locked

bool OMC::PaletteList::locked

read

Whether the Palette locked is currently locked for modifications.

◆ operator[int index]

OMC::Palette* OMC::PaletteList::operator[int index]

Provides the Palette object at the given index.

Returns: Returns the Palette object at index, or throws error.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;
if palette_list.size() != 0:
  print(palette_list[0]) # Prints the string representation of the Palette object.

◆ path

QString OMC::PaletteList::path

read

The path to the PaletteList on disk.

◆ type

QString OMC::PaletteList::type

read

The type of PaletteList, coudl either be Colour or Pencil Texture.

◆ valid

bool OMC::PaletteList::valid

read

True if the PaletteList object is valid.

Inheritance diagram for OMC::PaletteList:

[legend]

Collaboration diagram for OMC::PaletteList:

[legend]

Detailed Description

Public Member Functions

Public Attributes

Member Function Documentation

◆ clear()

◆ clone()

◆ contains()

◆ create()

◆ duplicate()

◆ element()

◆ find()

◆ list()

◆ lock()

◆ move_palette_down()

◆ move_palette_up()

◆ palette_containing_colour()

◆ palette_names()

◆ release()

◆ remove()

◆ reorder()

Member Data Documentation

◆ element_id

◆ id

◆ loaded

◆ locked

◆ operator[int index]

◆ path

◆ type

◆ valid