FormIt::Files API

Description

Classes
struct	FormIt::Files::FileOptions
	FormIt::Files::FileOptions struct. More...
class	FormIt::Files::FileOptionsList
	FormIt::Files::FileOptionsList class. More...

Enumerations
enum	FormIt::Files::Action { FormIt::Files::Action::Open = 0, FormIt::Files::Action::Save = 1, FormIt::Files::Action::Export = 2, FormIt::Files::Action::Import = 3 }
	A file action refers to Open/Save/Export a type of FormIt::Files::ContentType enum class. More...
enum	FormIt::Files::ContentType { FormIt::Files::ContentType::Type_Image = 0, FormIt::Files::ContentType::Type_3DModel = 1, FormIt::Files::ContentType::Type_Movie = 2 }
	Content of the file. More...
enum	FormIt::Files::Types {   FormIt::Files::Types::AXM = 0, FormIt::Files::Types::AXMF = 1, FormIt::Files::Types::AXMB = 2, FormIt::Files::Types::FBX = 3,   FormIt::Files::Types::OBJ = 4, FormIt::Files::Types::SAT = 5, FormIt::Files::Types::STL = 6, FormIt::Files::Types::WSM = 7,   FormIt::Files::Types::LMV = 8, FormIt::Files::Types::SKP = 9, FormIt::Files::Types::AutocadDXF = 10, FormIt::Files::Types::AutocadDWG = 11,   FormIt::Files::Types::ColladaDAE = 12, FormIt::Files::Types::PNG = 13, FormIt::Files::Types::JPG = 14, FormIt::Files::Types::JPEG = 15,   FormIt::Files::Types::SPD = 16, FormIt::Files::Types::JS = 17, FormIt::Files::Types::JSON = 18, FormIt::Files::Types::ATFX = 19,   FormIt::Files::Types::WMV = 20, FormIt::Files::Types::MP4 = 21 }
	All existing file types in FormIt. More...

Functions
FORMIT_CORE_EXPORT FormIt::Files::FileOptionsList	FormIt::Files::GetSupportedFilesList (const FormIt::Files::Action &action, const FormIt::Files::ContentType &type, bool useDevFormat=false, const FormIt::UI::FormItDialogBox &dialog=FormIt::UI::FormItDialogBox::Local)
	Get Platform's supported files. More...
FORMIT_CORE_EXPORT bool	FormIt::Files::IsFileSupported (const 1::string &extension, const FormIt::Files::Action &action, const FormIt::Files::ContentType &type, const FormIt::UI::FormItDialogBox &dialog=FormIt::UI::FormItDialogBox::Local)
	Check if a file extension is supported. More...
	FormIt::Files::DECL (Png, Types::PNG,"PNG file (*.png)","png") DECL(Json
	xBaseOption class declaration These string are duplicated in the cpp with a TR() for localization. More...
	FormIt::Files::DECL (Atfx, Types::ATFX,"ATF XML file (*.atfx)","atfx")
	FormIt::Files::DECL (Wmv, Types::WMV,"WMV Video file (*.wmv)","wmv")
	FormIt::Files::DECL (Mp4, Types::MP4,"MP4 Video file (*.mp4)","mp4")
	FormIt::Files::DECL_IMPORT (Png) DECL_START_EXPORT(Png) int m_width
	xImportsOptions classes declaration More...

Variables
Solid def file	FormIt::Files::json
int	FormIt::Files::m_height
bool	FormIt::Files::m_doubleSided = false
bool	FormIt::Files::m_isAscii = false
::string	FormIt::Files::m_version = ""
	blank indicates latest version More...
bool	FormIt::Files::m_withHistory = false

Enumeration Type Documentation

enum FormIt::Files::Action

strong

A file action refers to Open/Save/Export a type of FormIt::Files::ContentType enum class.

Enumerator
Open
Save
Export
Import

enum FormIt::Files::ContentType

strong

Content of the file.

Enumerator
Type_Image
Type_3DModel
Type_Movie

enum FormIt::Files::Types

strong

All existing file types in FormIt.

Enumerator
AXM
AXMF
AXMB
FBX
OBJ
SAT
STL
WSM
LMV
SKP
AutocadDXF
AutocadDWG
ColladaDAE
PNG
JPG
JPEG
SPD
JS
JSON
ATFX
WMV
MP4

Function Documentation

FormIt::Files::DECL	(	Png	,
		Types::PNG	,
		"PNG file (*.png)"	,
		"png"
	)

xBaseOption class declaration These string are duplicated in the cpp with a TR() for localization.

If you add a new file type you need to add it to the cpp file as well.

FormIt::Files::DECL	(	Atfx	,
		Types::ATFX	,
		"ATF XML file (*.atfx)"	,
		"atfx"
	)

FormIt::Files::DECL	(	Wmv	,
		Types::WMV	,
		"WMV Video file (*.wmv)"	,
		"wmv"
	)

FormIt::Files::DECL	(	Mp4	,
		Types::MP4	,
		"MP4 Video file (*.mp4)"	,
		"mp4"
	)

FormIt::Files::DECL_IMPORT

(

Png

)

xImportsOptions classes declaration

xExportOptions classes declaration < PngExportOptions

FORMIT_CORE_EXPORT FormIt::Files::FileOptionsList FormIt::Files::GetSupportedFilesList	(	const FormIt::Files::Action &	action,
		const FormIt::Files::ContentType &	type,
		bool	useDevFormat = false,
		const FormIt::UI::FormItDialogBox &	dialog = FormIt::UI::FormItDialogBox::Local
	)

Get Platform's supported files.

Parameters

	action	File action (eg: Load or Save file)
	type	File's content type (eg: 3D Model or Image)
	type	dev format or not
	type	Dialogbox in which we have to show the supported file formats
[in]	useDevFormat
[in]	dialog

FORMIT_CORE_EXPORT bool FormIt::Files::IsFileSupported	(	const 1::string &	extension,
		const FormIt::Files::Action &	action,
		const FormIt::Files::ContentType &	type,
		const FormIt::UI::FormItDialogBox &	dialog = FormIt::UI::FormItDialogBox::Local
	)

Check if a file extension is supported.

Parameters

	extension	File extension to check if is supported
	action	File action (eg: Load or Save file)
	type	File's content type (eg: 3D Model or Image)
[in]	dialog

Variable Documentation

Solid def file FormIt::Files::json

bool FormIt::Files::m_doubleSided = false

int FormIt::Files::m_height

bool FormIt::Files::m_isAscii = false

::string FormIt::Files::m_version = ""

blank indicates latest version

bool FormIt::Files::m_withHistory = false