coat::scripto::UI Class Reference

Access to user interface. More...

Classes
struct	Default
	Default values for UI. More...

Public Types
enum	SelectPriority : BYTE { Undefined = 0, AlwaysFirst, count }
enum	AboutQ {   Undefined = 0, Expect, ExpectBeginPosition, ExpectBeginPositionX,   ExpectBeginPositionY, ExpectBeginPositionZ, ExpectButton, ExpectEndPosition,   ExpectEndPositionX, ExpectEndPositionY, ExpectEndPositionZ, ExpectMenu,   ExpectPosition, ExpectPositionX, ExpectPositionY, ExpectPositionZ,   ExpectSize, ExpectSizeX, ExpectSizeY, ExpectSizeZ,   Reduced, count }
enum	AboutWidget {   Undefined = 0, Can, CanChange, CanChangeName,   CanChangeHint, CanChangeValue, CanChangeValueBool, CanChangeValueFloat,   CanChangeValueInt, CanChangeValueText, CanSetValue = CanChangeValue, CanSetValueBool = CanChangeValueBool,   CanSetValueFloat = CanChangeValueFloat, CanSetValueInt = CanChangeValueInt, CanSetValueText = CanChangeValueText, CanGetValue,   CanGetValueBool, CanGetValueFloat, CanGetValueInt, CanGetValueText,   CanPress, Has, HasAnyName, HasCodeName,   HasHintName, HasUIName, Is, IsBeginPosition,   IsBeginPositionX, IsBeginPositionY, IsBeginPositionZ, IsButton,   IsEndPosition, IsEndPositionX, IsEndPositionY, IsEndPositionZ,   IsInputField, IsMenu, IsPanel, IsPosition,   IsPositionX, IsPositionY, IsPositionZ, IsScale,   IsScaleX, IsScaleY, IsScaleZ, IsSize,   IsSizeX, IsSizeY, IsSizeZ, IsSlider,   count }
enum	AboutQWidget {   Undefined = 0, EqualsHint, EqualsInnerCode, EqualsVisibleName,   count }
enum	Aim {   Undefined = 0, Press, Get, Change,   Set = Change, count }
typedef std::function< void(void) >	command_t
typedef std::string	commandKey_t
typedef std::map< commandKey_t, command_t >	commands_t

Public Member Functions
const Default &	getDefault ()
Wizard	wizard ()
	Builds a wizard for run some sequence by.
UI &	lang (const std::string &s)
	Set a language for user interface. More...
std::string	lang () const
UI &	language (const std::string &)
std::string	language () const
std::string	operator[] (const std::string &)
	Get value from input field / slider.
UI &	apply (const std::string &)
	Direct acces to run methods. More...
UI &	operator() (const std::string &)
	Left-click to button / pane / input field / slider / etc. More...
template<typename T >
UI &	operator() (const std::string &, const T &)
	Set a value to input field / slider / etc. If calls with empty string then clears warnings.
std::string	all () const
bool	enableWindow (const std::string &name, const bool eflag)
float	calculate (const std::string &, bool ignorePopupError) const
bool	activeWindow (const std::string &name, const bool aflag)
std::string	code (const std::string &)
UI &	selectPriority (const SelectPriority &v)
SelectPriority	selectPriority () const
UI &	toPaintRoom ()
	Switch to Paint room.
UI &	toRenderRoom ()
	Switch to Render room.
UI &	toRetopoRoom ()
	Switch to Retopo room.
UI &	toSculptRoom ()
	Switch to Sculpt room.
UI &	toUVRoom ()
	Switch to UV room.
UI &	a (const Vec3 &v)
	The default value. More...
Vec3	a () const
UI &	ax (const float &v)
float	ax () const
UI &	ay (const float &v)
float	ay () const
UI &	az (const float &v)
float	az () const
UI &	begin (const Vec3 &v)
Vec3	begin () const
UI &	b (const Vec3 &v)
	The default value. More...
Vec3	b () const
UI &	bx (const float &v)
float	bx () const
UI &	by (const float &v)
float	by () const
UI &	bz (const float &v)
float	bz () const
UI &	end (const Vec3 &v)
Vec3	end () const
UI &	button (const std::string &v)
	The default button which will press on modal choice-windows. More...
std::string	button () const
float	capA () const
	The default value. More...
UI &	capA (const float &v)
float	capB () const
UI &	capB (const float &v)
int	colorFileExtensionEnum () const
	The default value. More...
UI &	colorFileExtensionEnum (const int &v)
int	glossFileExtensionEnum () const
	The default value. More...
UI &	glossFileExtensionEnum (const int &v)
int	normalMapFileExtensionEnum () const
	The default value. More...
UI &	normalMapFileExtensionEnum (const int &v)
UI &	file (const std::string &v)
	The default file for input / output from / into user folder. More...
std::string	file () const
float	height () const
	The default value. More...
UI &	height (const float &v)
bool	needAO () const
	The default value. More...
UI &	needAO (const bool &v)
bool	needBakeLocalOcclusion () const
	The default value. More...
UI &	needBakeLocalOcclusion (const bool &v)
bool	needBump () const
	The default value. More...
UI &	needBump (const bool &v)
bool	needCoarseMesh () const
	The default value. More...
UI &	needCoarseMesh (const bool &v)
bool	needColor () const
	The default value. More...
UI &	needColor (const bool &v)
bool	needCurvature () const
	The default value. More...
UI &	needCurvature (const bool &v)
bool	needGeometry () const
	The default value. More...
UI &	needGeometry (const bool &v)
bool	needMetallness () const
	The default value. More...
UI &	needMetallness (const bool &v)
bool	needNormalMap () const
	The default value. More...
UI &	needNormalMap (const bool &v)
bool	needPadding () const
	The default value. More...
UI &	needPadding (const bool &v)
bool	needPreserveInitialNodes () const
	The default value. More...
UI &	needPreserveInitialNodes (const bool &v)
bool	needRoughness () const
	The default value. More...
UI &	needRoughness (const bool &v)
bool	needScale () const
	The default value. More...
UI &	needScale (const bool &v)
bool	needScreenBased () const
	The default value. More...
UI &	needScreenBased (const bool &v)
bool	needSpecular () const
	The default value. More...
UI &	needSpecular (const bool &v)
bool	needSpecularAsNormalMapAlpha () const
	The default value. More...
UI &	needSpecularAsNormalMapAlpha (const bool &v)
bool	needTaperingAngle () const
	The default value. More...
UI &	needTaperingAngle (const bool &v)
bool	needUVSetsAsTile () const
	The default value. More...
UI &	needUVSetsAsTile (const bool &v)
Vec3	position () const
	The default value. More...
UI &	position (const Vec3 &v)
float	radius () const
	The default value. More...
UI &	radius (const float &v)
float	bottomRadius () const
UI &	bottomRadius (const float &v)
float	relativeHoleRadius () const
UI &	relativeHoleRadius (const float &v)
float	topRadius () const
UI &	topRadius (const float &v)
UI &	rayCastingLength (const float &v)
	The default value. More...
float	rayCastingLength () const
UI &	reductionPercent (const float &v)
	The default value. More...
float	reductionPercent () const
int	resolutionEnum () const
	The default value. More...
UI &	resolutionEnum (const int &v)
bool	scaleA () const
	The default value. More...
UI &	scaleA (const bool &v)
bool	scaleB () const
UI &	scaleB (const bool &v)
Vec3	size () const
	The default value. More...
UI &	size (const Vec3 &v)
int	teeth () const
	The default value. More...
UI &	teeth (const int &v)
UI &	tempFile (const std::string &)
	The default temporary file for input / output from / into user folder. More...
std::string	tempFile () const
int	textureSizeEnum () const
	The default value. More...
UI &	textureSizeEnum (const int &v)
UI &	thickness (const float &v)
	The default value. More...
float	thickness () const
bool	useDiameter () const
	The default value. More...
UI &	useDiameter (const bool &v)
bool	useFillet () const
	The default value. More...
UI &	useFillet (const bool &v)
bool	useSector () const
	The default value. More...
UI &	useSector (const bool &v)
bool	skipDialog () const
	true when need skip an any dialog into the code. More...
UI &	skipDialog (const bool &v)
template<>
UI &	operator() (const std::string &q, const bool &v)
template<>
UI &	operator() (const std::string &q, const float &v)
template<>
UI &	operator() (const std::string &q, const int &v)

Static Public Member Functions
static UI *	instance ()
static bool	eqReduce (const std::string &a, const std::string &b)
	Equals based on reduce. More...
static std::string	normalize (const std::string &name)

Static Public Attributes
static const char *	strEnumAim []

Static Protected Member Functions
static void	undercuts ()

Detailed Description

Access to user interface.

Since

4.7

Member Enumeration Documentation

enum coat::scripto::UI::AboutQ

strong

See Also

coat::BitKnowledge

enum coat::scripto::UI::AboutWidget

strong

See Also

coat::BitKnowledge

enum coat::scripto::UI::AboutQWidget

strong

See Also

coat::BitKnowledge

enum coat::scripto::UI::Aim

strong

See Also

findWidget()

Member Function Documentation

UI& coat::scripto::UI::lang ( const std::string &  s )

inline

Set a language for user interface.

See Also

InitLanguages() for values which returns.

Warning

Restrict by StateKeeper.

UI & coat::scripto::UI::apply

(

const std::string &

q

)

Direct acces to run methods.

Faster than operator()().

See Also

operator()( const std::string& )

UI & coat::scripto::UI::operator()

(

const std::string &

q

)

Left-click to button / pane / input field / slider / etc.

Slower than apply(). apply()

std::string coat::scripto::UI::all

(

)

const

Returns

All titles from UI which active.

bool coat::scripto::UI::enableWindow	(	const std::string &	name,
		const bool	eflag
	)

Returns

true if widget name is enabled, otherwize false.

float coat::scripto::UI::calculate	(	const std::string &	s,
		bool	ignorePopupError
	)		const

Returns

Result which calculated. You can use any math functions from AngelScript: http://angelcode.com/angelscript/sdk/docs/manual/doc_addon_math.html If expression is error when return FLT_MAX. If expression is empty when return 0.

std::string coat::scripto::UI::code

(

const std::string &

q

)

Returns

Inner code which found. If not found, returns an empty string.

UI& coat::scripto::UI::a ( const Vec3 &  v )

inline

The default value.

See Also

begin()

Since

4.7.40

UI& coat::scripto::UI::begin ( const Vec3 &  v )

inline

See Also

a()

UI& coat::scripto::UI::b ( const Vec3 &  v )

inline

The default value.

See Also

end()

Since

4.7.40

UI& coat::scripto::UI::button ( const std::string &  v )

inline

The default button which will press on modal choice-windows.

Since

4.7.20

float coat::scripto::UI::capA ( ) const

inline

The default value.

See Also

capB()

Since

4.7.42

int coat::scripto::UI::colorFileExtensionEnum ( ) const

inline

The default value.

Since

4.8.06

Todo:

Create like UI::SelectPriority.

int coat::scripto::UI::glossFileExtensionEnum ( ) const

inline

The default value.

Since

4.8.06

Todo:

Create like UI::SelectPriority.

int coat::scripto::UI::normalMapFileExtensionEnum ( ) const

inline

The default value.

Since

4.8.06

Todo:

Create like UI::SelectPriority.

UI& coat::scripto::UI::file ( const std::string &  v )

inline

The default file for input / output from / into user folder.

Temporary file name will cleared.

See Also

tempFile()

Since

4.7.20

float coat::scripto::UI::height ( ) const

inline

The default value.

Since

4.7.42

bool coat::scripto::UI::needAO ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needBakeLocalOcclusion ( ) const

inline

The default value.

Since

4.7.42

bool coat::scripto::UI::needBump ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needCoarseMesh ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needColor ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needCurvature ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needGeometry ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needMetallness ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needNormalMap ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needPadding ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needPreserveInitialNodes ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needRoughness ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needScale ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needScreenBased ( ) const

inline

The default value.

Since

4.7.40

bool coat::scripto::UI::needSpecular ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needSpecularAsNormalMapAlpha ( ) const

inline

The default value.

Since

4.7.41

bool coat::scripto::UI::needTaperingAngle ( ) const

inline

The default value.

Since

4.7.40

bool coat::scripto::UI::needUVSetsAsTile ( ) const

inline

The default value.

Since

4.7.41

Vec3 coat::scripto::UI::position ( ) const

inline

The default value.

Since

4.7.42 Add px(), py(), pz()

float coat::scripto::UI::radius ( ) const

inline

The default value.

Since

4.7.42

UI& coat::scripto::UI::rayCastingLength ( const float &  v )

inline

The default value.

Since

4.7.42

UI& coat::scripto::UI::reductionPercent ( const float &  v )

inline

The default value.

Since

4.7.20

int coat::scripto::UI::resolutionEnum ( ) const

inline

The default value.

Since

4.8.06

Todo:

Create like UI::SelectPriority.

bool coat::scripto::UI::scaleA ( ) const

inline

The default value.

See Also

scaleB()

Since

4.7.42

Vec3 coat::scripto::UI::size ( ) const

inline

The default value.

Since

4.7.42 Add sx(), sy(), sz()

int coat::scripto::UI::teeth ( ) const

inline

The default value.

Since

4.7.42

UI & coat::scripto::UI::tempFile

(

const std::string &

v

)

The default temporary file for input / output from / into user folder.

File name will cleared. This file will removed when a script completed.

See Also

file()

Since

4.7.20

int coat::scripto::UI::textureSizeEnum ( ) const

inline

The default value.

Since

4.8.05

Todo:

Create like UI::SelectPriority.

UI& coat::scripto::UI::thickness ( const float &  v )

inline

The default value.

Since

4.7.20

bool coat::scripto::UI::useDiameter ( ) const

inline

The default value.

Since

4.7.42

bool coat::scripto::UI::useFillet ( ) const

inline

The default value.

Since

4.7.42

bool coat::scripto::UI::useSector ( ) const

inline

The default value.

Since

4.7.42

bool coat::scripto::UI::skipDialog ( ) const

inline

true when need skip an any dialog into the code.

Since

4.8.05

static bool coat::scripto::UI::eqReduce ( const std::string &  a, const std::string &  b  )

static

Equals based on reduce.

See Also

findWidget()

Member Data Documentation

const char * coat::scripto::UI::strEnumAim

static

Initial value:

= {
    "Undefined",
    "Press",
    "Get",
    "Set | Change",
}