OMC::PaletteTexture Class Reference

Detailed Description

Provides methods to access palette texture objects on a palette.

A Palette Texture object provides a palette that refers to another texture image and can be used for applying a texture to a drawing.

A Simple Example - Creating a new solid palette colour on the project and adding it a texture.

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;

# Create a new colour palette (it already comes with a default name and colour):
newPaletteType = 'Colour'
newPaletteName = 'Colour_Palette_Name'
newColourPalette = palette_list.create(newPaletteType,newPaletteName)

# Create a new texture palette:
new_texture_file_path = r'.../pathToTexture/texture.png'
new_texture_name = 'Texture_Colour'
new_texture_palette_colour = new_colour_palette.create_texture(new_texture_file_path,new_texture_name)

# Halve its width and height:
new_texture_palette_colour.width = new_texture_palette_colour.width / 2
new_texture_palette_colour.height = new_texture_palette_colour.height / 2

Public Member Functions
void	change_texture (QString filePath)
	Will load the file in a bitmap and make an internal copy. Throws error if unsuccessful. More...
OMC::PaletteList *	palette_list ()
	Gets the parent palette list, or throws error if currently parentless. More...
OMC::Palette *	palette ()
	Gets the parent palette, or throws error if currently parentless. More...

Public Attributes
bool	tiled
	Get and set whether the texture tiles. More...
unsigned int	width
	Get the texture width. More...
unsigned int	height
	Get the texture height. More...
QString	name
	The color pot name. More...
QString	base_type
	The base type of colour, either 'Colour' or 'Texture'. More...
QString	id
	Unique ID of the color. More...
bool	valid
	Get the validity of the object at the moment. More...

Member Function Documentation

change_texture()

void OMC::PaletteTexture::change_texture

(

QString

filePath

)

Will load the file in a bitmap and make an internal copy. Throws error if unsuccessful.

palette()

OMC::Palette* OMC::PaletteBaseColour::palette ( )

inherited

Gets the parent palette, or throws error if currently parentless.

Returns

The palette object.

Examplified in palette_list().

palette_list()

OMC::PaletteList* OMC::PaletteBaseColour::palette_list ( )

inherited

Gets the parent palette list, or throws error if currently parentless.

Returns

The palette list object.

Example:

from ToonBoom import harmony
palette_list = harmony.session().project.palettes;

# Clear the palette list of palettes (Optional)
palette_list.clear()

# Create a new colour palette:
new_colour_palette = palette_list.create('Colour','Palette_Name')

# Create new colour inside palette:
new_colour = new_colour_palette.create_solid_colour('Colour_A',[255,0,0])

# Access palette colours:
print(new_colour.palette_list().id == palette_list.id ) # True
print(new_colour.palette().id == new_colour_palette.id ) # True

Member Data Documentation

base_type

QString OMC::PaletteBaseColour::base_type

readinherited

The base type of colour, either 'Colour' or 'Texture'.

height

unsigned int OMC::PaletteTexture::height

readwrite

Get the texture height.

id

QString OMC::PaletteBaseColour::id

readinherited

Unique ID of the color.

name

QString OMC::PaletteBaseColour::name

readwriteinherited

The color pot name.

tiled

bool OMC::PaletteTexture::tiled

readwrite

Get and set whether the texture tiles.

valid

bool OMC::PaletteBaseColour::valid

readinherited

Get the validity of the object at the moment.

width

unsigned int OMC::PaletteTexture::width

readwrite

Get the texture width.

Inheritance diagram for OMC::PaletteTexture:

Collaboration diagram for OMC::PaletteTexture: