3DCoat  3D-COAT 4.9.xx
3DCoat is the one application that has all the tools you need to take your 3D idea from a block of digital clay all the way to a production ready, fully textured organic or hard surface model.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
coat::scripto::UI Class Reference

Access to user interface. More...

#include <SUI.h>

Classes

struct  Default
 Default values for UI. More...
 

Public Types

enum  AboutQ
 
enum  AboutWidget
 
enum  AboutQWidget
 
enum  Aim
 

Public Member Functions

Wizard wizard ()
 Builds a wizard for run some sequence by. More...
 
UI & lang (const std::string &s)
 Set a language for user interface. More...
 
std::string operator[] (const std::string &)
 Get value from input field / slider. More...
 
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. More...
 
std::string all () const
 
bool enableWindow (const std::string &name, const bool eflag)
 
float calculate (const std::string &, bool ignorePopupError) const
 
std::string code (const std::string &)
 
UI & toPaintRoom ()
 Switch to Paint room. More...
 
UI & toRenderRoom ()
 Switch to Render room. More...
 
UI & toRetopoRoom ()
 Switch to Retopo room. More...
 
UI & toSculptRoom ()
 Switch to Sculpt room. More...
 
UI & toUVRoom ()
 Switch to UV room. More...
 
UI & a (const Vec3 &v)
 The default value. More...
 
UI & begin (const Vec3 &v)
 
UI & b (const Vec3 &v)
 The default value. More...
 
UI & exportPreset (const std::string &v)
 The export preset. More...
 
UI & button (const std::string &v)
 The default button which will press on modal choice-windows. More...
 
float capA () const
 The default value. More...
 
int colorFileExtensionEnum () const
 The default value. More...
 
int glossFileExtensionEnum () const
 The default value. More...
 
int normalMapFileExtensionEnum () const
 The default value. More...
 
UI & file (const std::string &v)
 The default file for input / output from / into user folder. More...
 
float height () const
 The default value. More...
 
bool needAO () const
 The default value. More...
 
bool needBakeLocalOcclusion () const
 The default value. More...
 
bool needBump () const
 The default value. More...
 
bool needCoarseMesh () const
 The default value. More...
 
bool needColor () const
 The default value. More...
 
bool needCurvature () const
 The default value. More...
 
bool needGeometry () const
 The default value. More...
 
bool needMetallness () const
 The default value. More...
 
bool needNormalMap () const
 The default value. More...
 
bool needPadding () const
 The default value. More...
 
bool needPreserveInitialNodes () const
 The default value. More...
 
bool needRoughness () const
 The default value. More...
 
bool needScale () const
 The default value. More...
 
bool needScreenBased () const
 The default value. More...
 
bool needSpecular () const
 The default value. More...
 
bool needSpecularAsNormalMapAlpha () const
 The default value. More...
 
bool needTaperingAngle () const
 The default value. More...
 
bool needUVSetsAsTile () const
 The default value. More...
 
Vec3 position () const
 The default value. More...
 
float radius () const
 The default value. More...
 
UI & rayCastingLength (const float &v)
 The default value. More...
 
UI & reductionPercent (const float &v)
 The default value. More...
 
int resolutionEnum () const
 The default value. More...
 
bool scaleA () const
 The default value. More...
 
Vec3 size () const
 The default value. More...
 
int teeth () const
 The default value. More...
 
UI & tempFile (const std::string &)
 The default temporary file for input / output from / into user folder. More...
 
int textureSizeEnum () const
 The default value. More...
 
UI & thickness (const float &v)
 The default value. More...
 
bool useDiameter () const
 The default value. More...
 
bool useFillet () const
 The default value. More...
 
bool useSector () const
 The default value. More...
 
bool skipUndo () const
 The default value. More...
 
bool skipDialog () const
 true when need skip an any dialog into the code. More...
 

Static Public Member Functions

static bool eqReduce (const std::string &a, const std::string &b)
 Equals based on reduce. More...
 

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::AboutQWidget
strong
See Also
coat::BitKnowledge
enum coat::scripto::UI::AboutWidget
strong
See Also
coat::BitKnowledge
enum coat::scripto::UI::Aim
strong
See Also
findWidget()

Member Function Documentation

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

The default value.

See Also
begin()
Since
4.7.40
std::string coat::scripto::UI::all ( ) const
Returns
All titles from UI which active.
UI & coat::scripto::UI::apply ( const std::string &  q)

Direct acces to run methods.

Faster than operator()().

See Also
operator()( const std::string& )

References operator()().

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

The default value.

See Also
end()
Since
4.7.40
UI& coat::scripto::UI::begin ( const Vec3 &  v)
inline
See Also
a()
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::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.
float coat::scripto::UI::capA ( ) const
inline

The default value.

See Also
capB()
Since
4.7.42
std::string coat::scripto::UI::code ( const std::string &  q)
Returns
Inner code which found. If not found, returns an empty string.

References empty().

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

The default value.

Since
4.8.06
Todo:
Create like UI::SelectPriority.
bool coat::scripto::UI::enableWindow ( const std::string &  name,
const bool  eflag 
)
Returns
true if widget name is enabled, otherwize false.
static bool coat::scripto::UI::eqReduce ( const std::string &  a,
const std::string &  b 
)
static

Equals based on reduce.

See Also
findWidget()
UI& coat::scripto::UI::exportPreset ( const std::string &  v)
inline

The export preset.

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
int coat::scripto::UI::glossFileExtensionEnum ( ) const
inline

The default value.

Since
4.8.06
Todo:
Create like UI::SelectPriority.
float coat::scripto::UI::height ( ) const
inline

The default value.

Since
4.7.42
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.
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
int coat::scripto::UI::normalMapFileExtensionEnum ( ) const
inline

The default value.

Since
4.8.06
Todo:
Create like UI::SelectPriority.
UI & coat::scripto::UI::operator() ( const std::string &  q)

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

Slower than apply(). apply()

References ui_root().

Referenced by apply().

template<typename T >
UI& coat::scripto::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 coat::scripto::UI::operator[] ( const std::string &  q)

Get value from input field / slider.

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()
bool coat::scripto::UI::skipDialog ( ) const
inline

true when need skip an any dialog into the code.

Since
4.8.05
bool coat::scripto::UI::skipUndo ( ) const
inline

The default value.

Since
4.7.42
int coat::scripto::UI::teeth ( ) const
inline

The default value.

Since
4.7.42

References tempFile().

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

Referenced by teeth().

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
UI& coat::scripto::UI::toPaintRoom ( )
inline

Switch to Paint room.

References toPaintRoom().

Referenced by toPaintRoom().

UI& coat::scripto::UI::toRenderRoom ( )
inline

Switch to Render room.

References toRenderRoom().

Referenced by toRenderRoom().

UI& coat::scripto::UI::toRetopoRoom ( )
inline

Switch to Retopo room.

References toRetopoRoom().

Referenced by toRetopoRoom().

UI& coat::scripto::UI::toSculptRoom ( )
inline

Switch to Sculpt room.

References toSculptRoom().

Referenced by toSculptRoom().

UI& coat::scripto::UI::toUVRoom ( )
inline

Switch to UV room.

References toUVRoom().

Referenced by toUVRoom().

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
Wizard coat::scripto::UI::wizard ( )

Builds a wizard for run some sequence by.

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