3DCoatScripting  4.8.31β
You can manage 3DСoat features with help of scripting
coat::scripto::File Class Reference

Class for working with file of... any format, including a text and just binary. More...

Public Member Functions

 File ()
 Constructor for building an empty file-object. More...
 
Filebinary (const bool &v)
 Setter for binary mode of file. More...
 
bool binary () const
 Getter a binary mode of file. More...
 
Fileextension (const std::string &)
 Setter for extension of file. More...
 
std::string extension () const
 Getter for extension of file. More...
 
FilefullPathFile (const std::string &v)
 Setter for full path with file name. More...
 
std::string fullPathFile () const
 Getter for full path with file name. More...
 
Filepath (const std::string &)
 Setter for path of file. More...
 
std::string path () const
 Getter for path of file. More...
 
template<class T >
Fileoperator= (const T &)
 Write to file with erase it. More...
 
template<class T >
Fileappend (const T &)
 Write to file with append to it. More...
 
template<class T >
Fileoperator+= (const T &v)
 Write to file with append to it. More...
 
Fileremove ()
 Removes the file. More...
 
template<>
Fileoperator= (const FormatBinary &b)
 
template<>
Fileoperator= (const FormatDAE &b)
 
template<>
Fileoperator= (const FormatFBX &b)
 
template<>
Fileoperator= (const FormatOBJ &b)
 
template<>
Fileappend (const FormatBinary &b)
 
template<>
Fileappend (const unsigned char &d)
 

Detailed Description

Class for working with file of... any format, including a text and just binary.

file.jpg
Since
4.5.32

Constructor & Destructor Documentation

coat::scripto::File::File ( )
inline

Constructor for building an empty file-object.

See Also
file( const string& )

Member Function Documentation

File& coat::scripto::File::binary ( const bool &  v)
inline

Setter for binary mode of file.

File a( "a.data" );
a.binary( true );
See Also
File( const string&, bool )
bool coat::scripto::File::binary ( ) const
inline

Getter a binary mode of file.

File a( "a.dat", true );
bool r = a.binary();
File & coat::scripto::File::extension ( const std::string &  v)

Setter for extension of file.

File a( "a" );
a.extension( "json" );
std::string coat::scripto::File::extension ( ) const

Getter for extension of file.

File a( "a.obj" );
string r = a.extension();
File& coat::scripto::File::fullPathFile ( const std::string &  v)
inline

Setter for full path with file name.

File a( "3DCoat/examples/my/a.txt" );
a.fullPathFile( "3DCoat/examples/a1.txt" );
std::string coat::scripto::File::fullPathFile ( ) const
inline

Getter for full path with file name.

File a( "3DCoat/examples/my/a.txt" );
string r = a.fullPathFile();
File & coat::scripto::File::path ( const std::string &  v)

Setter for path of file.

Todo:

name of file with extension

std::string name() const;

Todo:
File& name( const std::string& );
File a( "any/path/a.fbx" );
a.path( "3DCoat/examples/my" );
std::string coat::scripto::File::path ( ) const

Getter for path of file.

File a( "3DCoat/examples/my/a.fbx" );
string r = a.path();
template<class T >
File& coat::scripto::File::operator= ( const T &  )

Write to file with erase it.

File a( "3DCoat/examples/my/a.txt" );
a = "Line for demo...\n"
"and yet one, yes!";
File a( "3DCoat/examples/my/a" );
FormatBinary bin = { 0x46, 0x4c, 0x49, 0x46 };
a = bin;
File a( "3DCoat/examples/my/a" );
FormatFBX fbx;
// export the scene like FBX-format
a = fbx;
template<class T >
File& coat::scripto::File::append ( const T &  )

Write to file with append to it.

File a( "3DCoat/examples/my/a.txt" );
a += "Line for demo...\n"
"and yet, yes!";
File a( "3DCoat/examples/my/a" );
FormatBinary bin = { '.', '\r', '\n' };
a += bin;
template<class T >
File& coat::scripto::File::operator+= ( const T &  v)
inline

Write to file with append to it.

File a( "3DCoat/examples/my/a.txt" );
a += "Line for demo...\n"
"and yet, yes!";
File a( "3DCoat/examples/my/a" );
FormatBinary bin = { '.', '\r', '\n' };
a += bin;
File & coat::scripto::File::remove ( )

Removes the file.

Todo:

write to file with prepend

File& copy()

Todo:
File& clear();
File a( "a.txt" );
a.remove();