Castor3D 0.16.0
Multiplatform 3D engine
Public Member Functions | Protected Types | List of all members
castor::TextWriterT< T > Class Template Reference

Partial castor::Writer specialisation for text files. More...

#include <TextWriter.hpp>

Inheritance diagram for castor::TextWriterT< T >:
Inheritance graph
[legend]
Collaboration diagram for castor::TextWriterT< T >:
Collaboration graph
[legend]

Public Member Functions

 TextWriterT (String tabs, StringView name=String{})
 
- Public Member Functions inherited from castor::TextWriterBase
CU_API TextWriterBase (TextWriterBase const &rhs)=delete
 
CU_API TextWriterBaseoperator= (TextWriterBase const &rhs)=delete
 
CU_API TextWriterBase (TextWriterBase &&rhs) noexcept
 
CU_API TextWriterBaseoperator= (TextWriterBase &&rhs) noexcept
 
virtual CU_API ~TextWriterBase () noexcept=default
 
CU_API TextWriterBase (String tabs=cuEmptyString, StringView name=cuEmptyString)
 Constructor.
 
CU_API void checkError (bool error, xchar const *const action) const
 Reports eventual error.
 
CU_API void checkError (bool error, String const &action) const
 Reports eventual error.
 
CU_API void checkError (bool error, StringView const &action) const
 Reports eventual error.
 
CU_API WriterBlock beginBlock (StringStream &file)
 
CU_API WriterBlock beginBlock (StringStream &file, StringView name)
 
CU_API WriterBlock beginBlock (StringStream &file, String const &type, StringView name)
 
CU_API bool writeMask (StringStream &file, StringView name, uint32_t mask) const
 
CU_API bool writeMask (StringStream &file, StringView name, uint64_t mask) const
 
CU_API bool writeComment (StringStream &file, String const &comment) const
 
CU_API bool write (StringStream &file, String const &value) const
 
CU_API bool write (StringStream &file, StringView name, float value) const
 
CU_API bool write (StringStream &file, StringView name, double value) const
 
CU_API bool write (StringStream &file, StringView name, uint16_t value) const
 
CU_API bool write (StringStream &file, StringView name, int16_t value) const
 
CU_API bool write (StringStream &file, StringView name, uint32_t value) const
 
CU_API bool write (StringStream &file, StringView name, int32_t value) const
 
CU_API bool write (StringStream &file, StringView name, uint64_t value) const
 
CU_API bool write (StringStream &file, StringView name, int64_t value) const
 
CU_API bool write (StringStream &file, StringView name, bool value) const
 
CU_API bool write (StringStream &file, StringView name, WString const &value) const
 
CU_API bool write (StringStream &file, StringView name, MbString const &value) const
 
CU_API bool writeOpt (StringStream &file, StringView name, bool value) const
 
CU_API bool writeText (StringStream &file, WString const &value) const
 
CU_API bool writeText (StringStream &file, MbString const &value) const
 
CU_API bool writeName (StringStream &file, StringView name, WString const &value) const
 
CU_API bool writeName (StringStream &file, StringView name, MbString const &value) const
 
CU_API bool writeNameOpt (StringStream &file, StringView name, WString const &value, WString const &comp) const
 
CU_API bool writeNameOpt (StringStream &file, StringView name, MbString const &value, MbString const &comp) const
 
CU_API bool writePath (StringStream &file, StringView name, Path const &value) const
 
CU_API bool writeFile (StringStream &file, StringView name, Path const &source, Path const &folder, String const &subfolder) const
 
CU_API String tabs () const
 
template<typename Value1T , typename Value2T >
bool write (StringStream &file, StringView name, Value1T const &value1, Value2T const &value2) const
 
template<typename ValueT >
bool write (StringStream &file, StringView name, RangedValue< ValueT > const &value) const
 
template<typename ValueT >
bool write (StringStream &file, StringView name, ChangeTracked< ValueT > const &value) const
 
template<typename ValueT >
bool write (StringStream &file, StringView name, Point2< ValueT > const &value) const
 
template<typename ValueT >
bool write (StringStream &file, StringView name, Point3< ValueT > const &value) const
 
template<typename ValueT >
bool write (StringStream &file, StringView name, Point4< ValueT > const &value) const
 
template<typename ValueT >
bool writeOpt (StringStream &file, StringView name, ValueT const &value, ValueT const &comp) const
 
template<typename ValueT , typename ... ParamsT>
bool writeSub (StringStream &file, ValueT const &value, ParamsT const &... params) const
 
template<typename ValueT , typename ... ParamsT>
bool writeNamedSub (StringStream &file, StringView name, ValueT const &value, ParamsT const &... params) const
 
template<typename ValueT , typename ... ParamsT>
bool writeSubOpt (StringStream &file, ValueT const &value, ValueT const &comp, ParamsT const &... params) const
 
template<typename ValueT , typename ... ParamsT>
bool writeNamedSubOpt (StringStream &file, StringView name, ValueT const &value, ValueT const &comp, ParamsT const &... params) const
 
- Public Member Functions inherited from castor::Writer< T, StringStream >
virtual ~Writer () noexcept=default
 
virtual bool operator() (T const &object, Type &file)
 Writes a resource to a file.
 

Protected Types

using Type = typename Writer< T, StringStream >::Type
 
- Protected Types inherited from castor::Writer< T, StringStream >
using Type
 

Additional Inherited Members

- Static Public Member Functions inherited from castor::TextWriterBase
static CU_API Path copyFile (Path const &path, Path const &folder, Path const &subfolder)
 Copies the file with given path to output folder.
 
- Protected Member Functions inherited from castor::NonMovable
 NonMovable ()=default
 Constructor.
 
 ~NonMovable () noexcept=default
 Destructor.
 

Detailed Description

template<class T>
class castor::TextWriterT< T >

Partial castor::Writer specialisation for text files.

Member Typedef Documentation

◆ Type

template<class T >
using castor::TextWriterT< T >::Type = typename Writer< T, StringStream >::Type
protected

Constructor & Destructor Documentation

◆ TextWriterT()

template<class T >
castor::TextWriterT< T >::TextWriterT ( String tabs,
StringView name = String{} )
inlineexplicit

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