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
Static Public Member Functions | List of all members
coat::io Class Reference

General I/O access. More...

#include <CoreAPI.h>

Static Public Member Functions

static const char * installPath ()
 the 3DCoat installation path More...
 
static const char * dataPath ()
 the 3DCoat data path More...
 
static vec2 cursorPos ()
 returns the current cursor position More...
 
static vec2 snappedCursorPos ()
 returns the snapped cursor position More...
 
static Rct wholeScreen ()
 get the whole screen rectangle More...
 
static Rct workArea ()
 get the work area rectangle More...
 
static void progressBar (float stage, float max_stage, const char *message)
 Show the progress bar. More...
 
static void progressBarInWindowHeader (float stage, float max_stage, const char *message)
 Show the progress bar only in the 3DCoat's window header. More...
 
static void setWindowTitle (const char *text, float seconds)
 Override the 3DCoat's window title for some amount of time. More...
 
static void step (int count=1)
 perform rendering cycles More...
 
static void exec (const char *command, const char *arguments=nullptr)
 execete command. It may be exe file, URL, batch command More...
 
static str execAndWait (const char *command, const char *arguments=nullptr)
 execute and wait till finished, the console output will be returned as string More...
 

Detailed Description

General I/O access.

Member Function Documentation

comms::cVec2 coat::io::cursorPos ( )
static

returns the current cursor position

Returns
the 2d vector
const char * coat::io::dataPath ( )
static

the 3DCoat data path

Returns
the path
void coat::io::exec ( const char *  command,
const char *  arguments = nullptr 
)
static

execete command. It may be exe file, URL, batch command

Parameters
command
arguments
coat::str coat::io::execAndWait ( const char *  command,
const char *  arguments = nullptr 
)
static

execute and wait till finished, the console output will be returned as string

Parameters
commandthe command to execute
argumentsoptional arguments
Returns
the console output of the executed program
const char * coat::io::installPath ( )
static

the 3DCoat installation path

Returns
the path
void coat::io::progressBar ( float  stage,
float  max_stage,
const char *  message 
)
static

Show the progress bar.

Parameters
stagethe current stage
max_stagethe maximal stage
messagethe text to display
void coat::io::progressBarInWindowHeader ( float  stage,
float  max_stage,
const char *  message 
)
static

Show the progress bar only in the 3DCoat's window header.

Parameters
stage
max_stage
message
void coat::io::setWindowTitle ( const char *  text,
float  seconds 
)
static

Override the 3DCoat's window title for some amount of time.

Parameters
textthe text to show
secondsthe seconds to stay in title
comms::cVec2 coat::io::snappedCursorPos ( )
static

returns the snapped cursor position

Returns
the 2d vector
void coat::io::step ( int  count = 1)
static

perform rendering cycles

Parameters
countamount of cycles

Referenced by coat::ui::wait().

Rct coat::io::wholeScreen ( )
static

get the whole screen rectangle

Returns
the rectangle, top-left is (0,0)
Rct coat::io::workArea ( )
static

get the work area rectangle

Returns
the rectangle, top-left is (0,0)
The documentation for this class was generated from the following files: