This set of functions is used to query/modify the current penstyle and list of penstyles. The list of penstyles includes the brush, pencil and texture styles. More...

#include <penstyle.h>

Inheritance diagram for PenstyleManager:

[legend]

Collaboration diagram for PenstyleManager:

[legend]

Public Slots
int	getNumberOfPenstyles ()
	Gets the number of penstyles.

String	getPenstyleName (int index)
	Gets the name of the penstyle.

int	getCurrentPenstyleIndex ()
	Gets the index of the current penstyle.

String	getCurrentPenstyleName ()
	Gets the name of the current penstyle.

void	setCurrentPenstyleByName (String name)
	sets the current penstyle

void	setCurrentPenstyleByIndex (int index)
	sets the current penstyle

void	changeCurrentPenstyleMinimumSize (double minimum)
	set the current penstyle minimum size

void	changeCurrentPenstyleMaximumSize (double maximum)
	set the current penstyle maximum size

void	changeCurrentPenstyleOutlineSmoothness (double smooth)
	set the current penstyle outline smoothness

void	changeCurrentPenstyleCenterlineSmoothness (double smooth)
	set the current penstyle centreline smoothness

double	getCurrentPenstyleMinimumSize ()
	set the current penstyle eraser flag

double	getCurrentPenstyleMaximumSize ()
	Gets the current penstyle maximum size.

double	getCurrentPenstyleOutlineSmoothness ()
	Gets the current penstyle outline smoothness.

double	getCurrentPenstyleCenterlineSmoothness ()
	Gets the current penstyle center line smoothness.

bool	getCurrentPenstyleEraserFlag ()
	Gets the current penstyle eraser flag.

String	exportPenstyleToString (int index)
	Create a string representing the penstyle which can be used to store the penstyle and import it later.

String	exportPenstyleListToString ()
	Formats the penstyle list into a string, which can be used to store the penstyle list and import it later.

void	importPenstyleListFromString (String str)
	Imports a penstyle list from a previously formatted penstyle string.

void	savePenstyles ()
	Saves the penstyles.

Detailed Description

This set of functions is used to query/modify the current penstyle and list of penstyles. The list of penstyles includes the brush, pencil and texture styles.

function queryPenstyles()
{
 var num = PenstyleManager.getNumberOfPenstyles();
 for ( var i =0 ; i < num ; ++i )
 {
   System.println( "penstyle name is " + PenstyleManager.getPenstyleName(i) );
 }
  System.println("The current penstyle has min size of " +  PenstyleManager.getCurrentPenstyleMinimumSize() +
     " and maximum size of " +  PenstyleManager.getCurrentPenstyleMaximumSize());
}

Member Function Documentation

void PenstyleManager::changeCurrentPenstyleCenterlineSmoothness ( double smooth )

slot

set the current penstyle centreline smoothness

Parameters

smooth - new smoothness value

void PenstyleManager::changeCurrentPenstyleMaximumSize ( double maximum )

slot

set the current penstyle maximum size

Parameters

maximum - new maximum size

void PenstyleManager::changeCurrentPenstyleMinimumSize ( double minimum )

slot

set the current penstyle minimum size

Parameters

minimum - new minimum size

void PenstyleManager::changeCurrentPenstyleOutlineSmoothness ( double smooth )

slot

set the current penstyle outline smoothness

Parameters

smooth - new smoothness value

String PenstyleManager::exportPenstyleListToString ( )

slot

Formats the penstyle list into a string, which can be used to store the penstyle list and import it later.

Returns: string representing penstyle list

String PenstyleManager::exportPenstyleToString ( int index )

slot

Create a string representing the penstyle which can be used to store the penstyle and import it later.

Parameters

index - index of penstyle

Returns: string representing penstyle

double PenstyleManager::getCurrentPenstyleCenterlineSmoothness ( )

slot

Gets the current penstyle center line smoothness.

Returns: center line smoothness

bool PenstyleManager::getCurrentPenstyleEraserFlag ( )

slot

Gets the current penstyle eraser flag.

Returns: eraser flag

int PenstyleManager::getCurrentPenstyleIndex ( )

slot

Gets the index of the current penstyle.

Returns: index of penstyle

double PenstyleManager::getCurrentPenstyleMaximumSize ( )

slot

Gets the current penstyle maximum size.

Returns: maximum size

double PenstyleManager::getCurrentPenstyleMinimumSize ( )

slot

set the current penstyle eraser flag

Parameters

flag	- eraser settingGets the current penstyle minimum size

Returns: minimum size

String PenstyleManager::getCurrentPenstyleName ( )

slot

Gets the name of the current penstyle.

Returns: name of penstyle

double PenstyleManager::getCurrentPenstyleOutlineSmoothness ( )

slot

Gets the current penstyle outline smoothness.

Returns: outline smoothness

int PenstyleManager::getNumberOfPenstyles ( )

slot

Gets the number of penstyles.

Returns: number of penstyles

String PenstyleManager::getPenstyleName ( int index )

slot

Gets the name of the penstyle.

Parameters

index - index of style withing list

Returns: name of penstyle

void PenstyleManager::importPenstyleListFromString ( String str )

slot

Imports a penstyle list from a previously formatted penstyle string.

Parameters

str	- formatted penstyle list ( created from a previous call to exportPenstyleToString or exportPenstyleListToString )

void PenstyleManager::savePenstyles ( )

slot

Saves the penstyles.

void PenstyleManager::setCurrentPenstyleByIndex ( int index )

slot

sets the current penstyle

Parameters

index - index of penstyle

void PenstyleManager::setCurrentPenstyleByName ( String name )

slot

sets the current penstyle

Parameters

name	- name of penstyle

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

dox_files/objectScript/penstyle.h

Public Slots

Detailed Description

Member Function Documentation