This static class defines SDK/Script IO function helpers. More...

Inheritance diagram for IOHelpers:

Public Types
enum	EditPropertyMode { EDIT_PROPERTY_MODE_SET, EDIT_PROPERTY_MODE_ADD, EDIT_PROPERTY_MODE_MUL, EDIT_PROPERTY_MODE_CLEAR, EDIT_PROPERTY_MODE_DEFAULT, EDIT_PROPERTY_MODE_MUL_QUAT, EDIT_PROPERTY_MODE_COUNT }

Static Public Member Functions
static OfObject *	create_particles (AppObject &app, const CoreString &name, const CoreBasicArray< GMathVec3f > &positions, const CoreBasicArray< GMathVec3f > &normals=CoreBasicArray< GMathVec3f >(0, 0), const CoreBasicArray< GMathVec3f > &velocities=CoreBasicArray< GMathVec3f >(0, 0))
	Create a particle container from the specified arguments.

static bool	set_particles (OfObject &object, const CoreBasicArray< GMathVec3f > &positions, const CoreBasicArray< GMathVec3f > &normals=CoreBasicArray< GMathVec3f >(0, 0), const CoreBasicArray< GMathVec3f > &velocities=CoreBasicArray< GMathVec3f >(0, 0))
	Set a particle container from the specified arguments.

static bool	set_particles_properties (OfObject &object, const CoreBasicArray< ResourceProperty * > &properties)
	Set properties for a particle geometry from the specified arguments.

static bool	set_particles_properties (OfObject &object, const CoreBasicArray< GeometryPointProperty * > &properties)
	Set properties for a particle geometry from the specified arguments.

static bool	decimate_particles (OfObject &object, const CoreSet< unsigned long > &indices)
	Decimate a particle container from the specified arguments. Update properties accordingly.

static bool	move_particles_relative (OfObject &object, const CoreSet< unsigned long > &indices, const GMathVec3f &delta, unsigned short space)
	Move some particles within a particle container from the specified arguments.

static bool	move_particles_absolute (OfObject &object, const CoreBasicArray< unsigned long > &indices, const CoreBasicArray< GMathVec3f > &positions)
	Set position of some particles within a particle container from the specified arguments.

static bool	add_particles (OfObject &object, const CoreBasicArray< GMathVec3f > &positions, const CoreBasicArray< GMathVec3f > &normals=CoreBasicArray< GMathVec3f >(0, 0), const CoreBasicArray< GMathVec3f > &velocities=CoreBasicArray< GMathVec3f >(0, 0), const CoreBasicArray< GeometryPointProperty * > &properties=CoreBasicArray< GeometryPointProperty * >(0, 0))
	Grow a particle container from the specified arguments. Update properties accordingly.

static bool	edit_particles_property (OfObject &object, const CoreString &property, const CoreSet< unsigned long > &indices, EditPropertyMode mode, const CoreString &value)
	Edit property of some particles within a particle container from the specified arguments.

static bool	set_particles_property_values (OfObject &object, const CoreString &property, unsigned int type, unsigned int dim, const CoreSet< unsigned long > &indices, void *values)
	Edit property of some particles within a particle geometry from the specified arguments.

static bool	create_particles_property (OfConstObjectHandle object, const CoreString &property, unsigned int type, unsigned int dim, const CoreString &value)
	Add property to all particles within a particle geometry from the specified arguments.

static bool	rename_particles_property (OfConstObjectHandle object, const CoreString &property, const CoreString &name)
	Rename a property within a particle geometry.

static bool	delete_particles_properties (OfObject &object, const CoreVector< CoreString > &properties)
	Remove some properties from a particle geometry.

static CoreString	get_particles_property (OfObject &object, const CoreString &property_name, unsigned int index)
	Get information about a property from a particle geometry.

static OfObject *	create_polymesh (AppObject &app, const CoreString &name, const CoreBasicArray< GMathVec3f > &vertices, const CoreBasicArray< unsigned int > &faces_vertex_count, const CoreBasicArray< unsigned int > &faces_definition, const CoreBasicArray< CoreString > &shading_groups, const CoreBasicArray< unsigned int > &sg_face_association)
	Create a polymesh from the specified arguments.

static bool	save_image (AppObject &app, const ImageCanvas &image, const CoreString &filename, const ImageIOFileFormat::Save &format, const CoreString &color_space, const ImageIOFileFormat::OpenExrCompressionMethod &compression_method=ImageIOFileFormat::NO_COMPRESSION)
	Save the specified image with the specified format at the specified extension.

static bool	import_geometry (AppObject &app, const CoreString &filename, const int &import_mats_mode=0, const bool &display_info=true)
	Import one or multiple geometries from the specified filename.

static bool	import_geometries (AppObject &app, const CoreBasicArray< CoreString > &filenames, const int &import_mats_mode=0, const bool &display_info=true)
	Import one or multiple geometries from the specified filenames.

static bool	import_geometry (AppObject &app, const CoreString &filename, CoreVector< OfObject * > &geometries, const int &import_mats_mode=0, const bool &display_info=true)
	Import one or multiple geometries from the specified filename.

static bool	import_geometries (AppObject &app, const CoreBasicArray< CoreString > &filenames, CoreVector< OfObject * > &geometries, const int &import_mats_mode=0, const bool &display_info=true)
	Import one or multiple geometries from the specified filenames.

static bool	import_geometry (OfContext &context, const CoreString &filename, const int &import_mats_mode=0, const bool &display_info=true)
	Import one or multiple geometries from the specified filename.

static bool	import_geometries (OfContext &context, const CoreBasicArray< CoreString > &filenames, const int &import_mats_mode=0, const bool &display_info=true)
	Import one or multiple geometries from the specified filename.

static bool	import_geometry (OfContext &context, const CoreString &filename, CoreVector< OfObject * > &geometries, const int &import_mats_mode=0, const bool &display_info=true)
	Import one or multiple geometries from the specified filename.

static bool	import_geometries (OfContext &working_context, const CoreBasicArray< CoreString > &filenames, CoreVector< OfObject * > &geometries, const int &import_mats_mode=0, const bool &display_infos=true)
	Import one or multiple geometries from the specified filename.

static bool	export_geometry (AppObject &app, const CoreString &filename, const CoreVector< OfObject * > &geometries)
	Export one or multiple geometries to the specified filename.

static OfContext *	import_volume (AppObject &app, const CoreString &filename)
	Import a volume from the specified filename.

static OfContext *	import_volume (OfContext &context, const CoreString &filename)
	Import a volume from the specified filename.

static OfContext *	import_volumes (AppObject &app, const CoreBasicArray< CoreString > &filenames)
	Import one or multiple volumes from the specified filename.

static OfContext *	import_volumes (OfContext &context, const CoreBasicArray< CoreString > &filenames)
	Import one or multiple volumes from the specified filename.

static bool	import_image (AppObject &app, const CoreString &filename, OfObject *&image)
	Import one image from the specified filename.

static bool	import_images (AppObject &app, const CoreBasicArray< CoreString > &filenames, CoreVector< OfObject * > &images)
	Import one or multiple images from the specified filename.

static bool	import_image (OfContext &context, const CoreString &filename, OfObject *&image)
	Import one image from the specified filename.

static bool	import_images (OfContext &context, const CoreBasicArray< CoreString > &filenames, CoreVector< OfObject * > &images)
	Import one or multiple images from the specified filename.

static bool	import_texture (AppObject &app, const CoreString &filename, const CoreString &class_name, const CoreString &suffix, OfObject *&texture)
	Import one texture from the specified filename.

static bool	import_textures (AppObject &app, const CoreBasicArray< CoreString > &filenames, const CoreString &class_name, const CoreString &suffix, CoreVector< OfObject * > &textures)
	Import one or multiple textures from the specified filename.

static bool	import_texture (OfContext &context, const CoreString &filename, const CoreString &class_name, const CoreString &suffix, OfObject *&texture)
	Import one texture from the specified filename.

static bool	import_textures (OfContext &context, const CoreBasicArray< CoreString > &filenames, const CoreString &class_name, const CoreString &suffix, CoreVector< OfObject * > &textures)
	Import one or multiple textures from the specified filename.

static bool	export_context_as_project (AppObject &app, const OfContext &context, const CoreString &filename)
	Export a context to the specified project filename.

static bool	export_context_as_project_with_dependencies (AppObject &app, const OfContext &context, const CoreString &filename)
	Export a context to the specified project filename, including its dependencies.

static bool	reference_export_context (AppObject &app, OfContext &context, const CoreString &filename)
	Export a context to the specified project filename.

static void	reload_resources (AppObject &app)
	Reload resources (Force the synchronization of resources)

static void	resync_resources (AppObject &app)
	Resynchronize resources.

static OfContext *	import_scene (AppObject &app, const CoreString &filename, AppProgressBar *load_progress_bar=nullptr)

static OfContext *	import_scene (OfContext &context, const CoreString &filename, AppProgressBar *load_progress_bar=nullptr)

static bool	import_scene (OfContext &import_context, const CoreString &filename, CoreVector< OfObject * > &imported_objects)

static OfContext *	import_project (AppObject &app, const CoreString &filename)
	Import a project from the specified filename.

static OfContext *	import_project (OfContext &context, const CoreString &filename)
	Import a project from the specified filename.

static OfContext *	reference_asset (AppObject &app, const CoreString &filename)
	Reference an asset from the specified filename.

static OfContext *	reference_asset (OfContext &context, const CoreString &filename)
	Reference an asset from the specified filename.

static bool	reference_file (OfContext &working_context, const CoreBasicArray< CoreString > &filenames)
	Reference files from the specified filenames.

static OfContext *	reference_file (OfContext &working_context, const CoreString &filename)
	Reference a file from the specified filename.

static bool	reference_files (OfContext &working_context, const CoreBasicArray< CoreString > &filenames, CoreVector< OfContext * > &refs)
	Reference files from the specified filenames.

static void	reference_make_local (AppObject &app, OfContext &context)
	Make local the specified reference.

static void	reference_make_local (AppObject &app, const CoreBasicArray< CoreString > &context_paths)
	Make local the specified reference paths.

static bool	export_to_alembic (AbcExportOptions &options)
	Exports objects to an alembic Archive.

static void	save_icon (OfClass &cls, const CoreString &filename, const int &size=128)
	Export a class internal icon to an output image file.

static void	extract_shading_layer (OfObject &result_sl, OfObject &group, OfObject &shading_layer)
	Extract a new shading layer from an input shading layer and a group of scene objects.

static void	extract_shading_layer (OfObject &result_sl, OfObject &object)
	Extract a new shading layer from an input layer 3d by creating absolute rules.

static OfItem *	pick_item (GuiApp &app, const CoreBasicArray< CoreString > &filter_classes, const CoreString &title="")
	Popup the browser picker and return the selected OfItem.

static OfItemHandle	pick_item (GuiApp &app, const CoreBasicArray< CoreString > &filter_classes, const OfContext &path, const CoreString &title="")
	Popup the browser picker and return the selected OfItem.

static void	pick_items (GuiApp &app, CoreVector< OfItemHandle > &selection, const CoreBasicArray< CoreString > &filter_classes, const CoreString &title="")
	Popup the browser picker and return the selected OfItem items.

static void	pick_items (GuiApp &app, CoreVector< OfItemHandle > &selection, const CoreBasicArray< CoreString > &filter_classes, const OfContext &path, const CoreString &title="")
	Popup the browser picker and return the selected OfItem items.

static OfObject *	pick_object (GuiApp &app, const CoreBasicArray< CoreString > &filter_classes, const CoreString &title="")
	Popup the browser picker and return the selected OfObject.

static OfObjectHandle	pick_object (GuiApp &app, const CoreBasicArray< CoreString > &filter_classes, const OfContext &path, const CoreString &title="")
	Popup the browser picker and return the selected OfObject.

static void	pick_objects (GuiApp &app, CoreVector< OfObjectHandle > &selection, const CoreBasicArray< CoreString > &filter_classes, const CoreString &title="")
	Popup the browser picker and return the selected OfObject items.

static void	pick_objects (GuiApp &app, CoreVector< OfObjectHandle > &selection, const CoreBasicArray< CoreString > &filter_classes, const OfContext &path, const CoreString &title="")
	Popup the browser picker and return the selected OfObject items.

static OfContext *	pick_context (GuiApp &app, const CoreString &title="")
	Popup the browser picker and return the selected OfContext.

static OfContext *	pick_context (GuiApp &app, const OfContext &path, const CoreString &title="")
	Popup the browser picker and return the selected OfContext.

static void	pick_contexts (GuiApp &app, CoreVector< OfContext * > &selection, const CoreString &title="")
	Popup the browser picker and return the selected OfContext items.

static void	pick_contexts (GuiApp &app, CoreVector< OfContext * > &selection, const OfContext &path, const CoreString &title="")
	Popup the browser picker and return the selected OfContext items.

static OfItemHandle	pick_source_for_selection (GuiApp &app, const CoreVector< OfItemHandle > &selection)
	Popup the browser picker and return the selected OfObject that can be used as source for current selection.

Static Public Member Functions inherited from CoreBaseType
static const CoreClassInfo &	class_info ()
	Get the type descriptor of this instance.

Additional Inherited Members
Public Member Functions inherited from CoreBaseType
bool	is_kindof (const CoreClassInfo &cinfo) const

Detailed Description

This static class defines SDK/Script IO function helpers.

Member Function Documentation

bool IOHelpers::add_particles	(	OfObject &	object,
		const CoreBasicArray< GMathVec3f > &	positions,
		const CoreBasicArray< GMathVec3f > &	normals = `CoreBasicArray<GMathVec3f>(0, 0)`,
		const CoreBasicArray< GMathVec3f > &	velocities = `CoreBasicArray<GMathVec3f>(0, 0)`,
		const CoreBasicArray< GeometryPointProperty * > &	properties = `CoreBasicArray<GeometryPointProperty *>(0, 0)`
	)

static

Grow a particle container from the specified arguments. Update properties accordingly.

Parameters

[in]	object	Particle container
[in]	positions	Array of positions
[in]	normals	Array of normals
[in]	velocities	Array of velocities
[in]	properties	Array of properties to merge

Returns: True if successful

OfObject * IOHelpers::create_particles	(	AppObject &	app,
		const CoreString &	name,
		const CoreBasicArray< GMathVec3f > &	positions,
		const CoreBasicArray< GMathVec3f > &	normals = `CoreBasicArray<GMathVec3f>(0, 0)`,
		const CoreBasicArray< GMathVec3f > &	velocities = `CoreBasicArray<GMathVec3f>(0, 0)`
	)

static

Create a particle container from the specified arguments.

Parameters

[in]	app	Application object
[in]	name	Particle container name
[in]	positions	Array of positions
[in]	normals	Array of normals
[in]	velocities	Array of velocities

Returns: Created OfObject if successful, Null otherwise

bool IOHelpers::create_particles_property	(	OfConstObjectHandle	object,
		const CoreString &	property,
		unsigned int	type,
		unsigned int	dim,
		const CoreString &	value
	)

static

Add property to all particles within a particle geometry from the specified arguments.

Note: Fully supported only on GeometryParticleContainer (on other classes, the modification may be lost upon reload).

Parameters

[in]	object	Particle geometry
[in]	property	Name of the property to create
[in]	type	Type of value as ResourceProperty::Type
[in]	dim	Number of subvalues
[in]	value	Actual value depends on property definition (type & dim). Several subvalues have to be separated by ' '.

Returns: True if successful

OfObject * IOHelpers::create_polymesh	(	AppObject &	app,
		const CoreString &	name,
		const CoreBasicArray< GMathVec3f > &	vertices,
		const CoreBasicArray< unsigned int > &	faces_vertex_count,
		const CoreBasicArray< unsigned int > &	faces_definition,
		const CoreBasicArray< CoreString > &	shading_groups,
		const CoreBasicArray< unsigned int > &	sg_face_association
	)

static

Create a polymesh from the specified arguments.

Parameters

[in]	app	Application object
[in]	name	Polymesh name
[in]	vertices	Array of vertices
[in]	faces_vertex_count	Array of number of vertices defining each face (3 for a triangle, 4 for a quad...)
[in]	faces_definition	Array of vertex id defining each faces
[in]	shading_groups	Array of shading group names
[in]	sg_face_association	Per face shading group association

Returns: Created OfObject if successful, Null otherwise

bool IOHelpers::decimate_particles	(	OfObject &	object,
		const CoreSet< unsigned long > &	indices
	)

static

Decimate a particle container from the specified arguments. Update properties accordingly.

Parameters

[in]	object	Particle container
[in]	indices	Set of particle indices to remove

Returns: True if successful

bool IOHelpers::delete_particles_properties	(	OfObject &	object,
		const CoreVector< CoreString > &	properties
	)

static

Remove some properties from a particle geometry.

Note: Fully supported only on GeometryParticleContainer (on other classes, the modification may be lost upon reload).

Parameters

[in]	object	Particle geometry
[in]	properties	Names of properties to remove

Returns: True if successful

bool IOHelpers::edit_particles_property	(	OfObject &	object,
		const CoreString &	property,
		const CoreSet< unsigned long > &	indices,
		EditPropertyMode	mode,
		const CoreString &	value
	)

static

Edit property of some particles within a particle container from the specified arguments.

Parameters

[in]	object	Particle container
[in]	property	Name of the property to edit
[in]	indices	Array of indices to edit. Empty array is a shortcut to edit all values
[in]	mode	Edit mode
[in]	value	Actual value depends on property definition (type & extent). After conversion, it is used to modify current value according to edit mode Number of subvalues must be either 1 (uniform) or match the property extent.

Returns: True if successful

bool IOHelpers::export_context_as_project	(	AppObject &	app,
		const OfContext &	context,
		const CoreString &	filename
	)

static

Export a context to the specified project filename.

Parameters

[in]	app	Application object
[in]	context	Context
[in]	filename	project filename

Returns: True if successful

bool IOHelpers::export_context_as_project_with_dependencies	(	AppObject &	app,
		const OfContext &	context,
		const CoreString &	filename
	)

static

Export a context to the specified project filename, including its dependencies.

Parameters

[in]	app	Application object
[in]	context	Context
[in]	filename	project filename

Returns: True if successful

bool IOHelpers::export_geometry	(	AppObject &	app,
		const CoreString &	filename,
		const CoreVector< OfObject * > &	geometries
	)

static

Export one or multiple geometries to the specified filename.

Parameters

[in]	app	Application object
[in]	filename	Geometry filename
[out]	geometries	OfObject geometries to export

Note: Geometries will be merged

Returns: True if successful

bool IOHelpers::export_to_alembic ( AbcExportOptions & options )

static

Exports objects to an alembic Archive.

Parameters

[in] Export options, including asset filename, animation range, etc...

Returns: True if the export succeeded, False if any error occurred.

void IOHelpers::extract_shading_layer	(	OfObject &	result_sl,
		OfObject &	group,
		OfObject &	shading_layer
	)

static

Extract a new shading layer from an input shading layer and a group of scene objects.

Parameters

[in]	result_sl	resulting shading layer
[in]	group	group defining a list of scene objects
[in]	shading_layer	shading layer defining rule overrides applied to scene objects
[in]	name	name of the output shading layer

void IOHelpers::extract_shading_layer	(	OfObject &	result_sl,
		OfObject &	object
	)

static

Extract a new shading layer from an input layer 3d by creating absolute rules.

Parameters

[in]	result_sl	resulting shading layer
[in]	object	input 3D layer or in group defining a list of scene objects
[in]	name	Name of the output shading layer

CoreString IOHelpers::get_particles_property	(	OfObject &	object,
		const CoreString &	property_name,
		unsigned int	index
	)

static

Get information about a property from a particle geometry.

Parameters

[in]	object	Particle geometry
[in]	property_name	Name of property
[in]	index	index of the particle

Returns: particle property value

bool IOHelpers::import_geometries	(	AppObject &	app,
		const CoreBasicArray< CoreString > &	filenames,
		const int &	import_mats_mode = `0`,
		const bool &	display_info = `true`
	)

static

Import one or multiple geometries from the specified filenames.

Parameters

[in]	app	Application object
[in]	filenames	Geometry filenames
[in]	import_mats_mode	Specify the import mode for the materials (only .obj) -1:no import, 0:ask, 1:import
[in]	display_infos	Enable or disable the display informations (enable by default)

Note: Depending on the file format, multiple geometries can be created from a single filename

Returns: True if success

bool IOHelpers::import_geometries	(	AppObject &	app,
		const CoreBasicArray< CoreString > &	filenames,
		CoreVector< OfObject * > &	geometries,
		const int &	import_mats_mode = `0`,
		const bool &	display_info = `true`
	)

static

Import one or multiple geometries from the specified filenames.

Parameters

[in]	app	Application object
[in]	filenames	Geometry filenames
[out]	geometries	OfObject geometries that were created after import
[in]	import_mats_mode	Specify the import mode for the materials (only .obj) -1:no import, 0:ask, 1:import
[in]	display_infos	Enable or disable the display informations (enable by default)

Note: Depending on the file format, multiple geometries can be created from a single filename

Returns: True if successful

bool IOHelpers::import_geometries	(	OfContext &	context,
		const CoreBasicArray< CoreString > &	filenames,
		const int &	import_mats_mode = `0`,
		const bool &	display_info = `true`
	)

static

Import one or multiple geometries from the specified filename.

Parameters

[in]	context	Context that will contain the imported geometries
[in]	filenames	Geometry filenames
[in]	import_mats_mode	Specify the import mode for the materials (only .obj) -1:no import, 0:ask, 1:import
[in]	display_infos	Enable or disable the display informations (enable by default)

Note: Depending on the file format, multiple geometries can be created from a single filename

Returns: True if success

bool IOHelpers::import_geometries	(	OfContext &	working_context,
		const CoreBasicArray< CoreString > &	filenames,
		CoreVector< OfObject * > &	geometries,
		const int &	import_mats_mode = `0`,
		const bool &	display_infos = `true`
	)

static

Import one or multiple geometries from the specified filename.

Parameters

[in]	context	Context that will contain the imported geometries
[in]	filenames	Geometry filenames
[out]	geometries	OfObject geometries that were created after import
[in]	import_mats_mode	Specify the import mode for the materials (only .obj) -1:no import, 0:ask, 1:import
[in]	display_infos	Enable or disable the display informations (enable by default)

Note: Depending on the file format, multiple geometries can be created from a single filename

Returns: True if successful

bool IOHelpers::import_geometry	(	AppObject &	app,
		const CoreString &	filename,
		const int &	import_mats_mode = `0`,
		const bool &	display_info = `true`
	)

static

Import one or multiple geometries from the specified filename.

Parameters

[in]	app	Application object
[in]	filename	Geometry filename
[in]	import_mats_mode	Specify the import mode for the materials (only .obj) -1:no import, 0:ask, 1:import
[in]	display_infos	Enable or disable the display informations (enable by default)

Note: Depending on the file format, multiple geometries can be created from a single filename

Returns: True if success

bool IOHelpers::import_geometry	(	AppObject &	app,
		const CoreString &	filename,
		CoreVector< OfObject * > &	geometries,
		const int &	import_mats_mode = `0`,
		const bool &	display_info = `true`
	)

static

Import one or multiple geometries from the specified filename.

Parameters

[in]	app	Application object
[in]	filename	Geometry filename
[out]	geometries	OfObject geometries that were created after import
[in]	import_mats_mode	Specify the import mode for the materials (only .obj) -1:no import, 0:ask, 1:import
[in]	display_infos	Enable or disable the display informations (enable by default)

Note: Depending on the file format, multiple geometries can be created from a single filename

Returns: True if successful

bool IOHelpers::import_geometry	(	OfContext &	context,
		const CoreString &	filename,
		const int &	import_mats_mode = `0`,
		const bool &	display_info = `true`
	)

static

Import one or multiple geometries from the specified filename.

Parameters

[in]	context	Context that will contain the imported geometries
[in]	filename	Geometry filename
[in]	import_mats_mode	Specify the import mode for the materials (only .obj) -1:no import, 0:ask, 1:import
[in]	display_infos	Enable or disable the display informations (enable by default)

Note: Depending on the file format, multiple geometries can be created from a single filename

Returns: True if success

bool IOHelpers::import_geometry	(	OfContext &	context,
		const CoreString &	filename,
		CoreVector< OfObject * > &	geometries,
		const int &	import_mats_mode = `0`,
		const bool &	display_info = `true`
	)

static

Import one or multiple geometries from the specified filename.

Parameters

[in]	context	Context that will contain the imported geometries
[in]	filename	Geometry filename
[out]	geometries	OfObject geometries that were created after import
[in]	import_mats_mode	Specify the import mode for the materials (only .obj) -1:no import, 0:ask, 1:import
[in]	display_infos	Enable or disable the display informations (enable by default)

Note: Depending on the file format, multiple geometries can be created from a single filename

Returns: True if successful

bool IOHelpers::import_image	(	AppObject &	app,
		const CoreString &	filename,
		OfObject *&	image
	)

static

Import one image from the specified filename.

Parameters

[in]	app	Application object
[in]	filename	Image filename
[out]	image	OfObject image is that was created after import

Returns: True if successful

bool IOHelpers::import_image	(	OfContext &	context,
		const CoreString &	filename,
		OfObject *&	image
	)

static

Import one image from the specified filename.

Parameters

[in]	context	Context that will contain the imported images
[in]	filename	Image filename
[out]	images	OfObject image is that was created after import

Returns: True if successful

bool IOHelpers::import_images	(	AppObject &	app,
		const CoreBasicArray< CoreString > &	filenames,
		CoreVector< OfObject * > &	images
	)

static

Import one or multiple images from the specified filename.

Parameters

[in]	app	Application object
[in]	filenames	Image filenames
[out]	images	OfObject images is that were created after import

Returns: True if successful

bool IOHelpers::import_images	(	OfContext &	context,
		const CoreBasicArray< CoreString > &	filenames,
		CoreVector< OfObject * > &	images
	)

static

Import one or multiple images from the specified filename.

Parameters

[in]	context	Context that will contain the imported images
[in]	filenames	Image filenames
[out]	images	OfObject images is that were created after import

Returns: True if successful

OfContext * IOHelpers::import_project	(	AppObject &	app,
		const CoreString &	filename
	)

static

Import a project from the specified filename.

Parameters

[in]	app	Application object
[in]	filename	Project filename

Note: Project defined variables are automatically appended to the variables defined in the current project

Returns: The created context containing the project

OfContext * IOHelpers::import_project	(	OfContext &	context,
		const CoreString &	filename
	)

static

Import a project from the specified filename.

Parameters

[in]	working_context	Context that will contain the imported scene
[in]	filename	Project filename

Note: project defined variables are automatically appended to the variables defined in the current project

Returns: The created context containing the project

OfContext * IOHelpers::import_scene	(	AppObject &	app,
		const CoreString &	filename,
		AppProgressBar *	load_progress_bar = `nullptr`
	)

static

Import a scene from the specified filename.

Parameters

app	Application object.
filename	Scene filename.
load_progress_bar	Optional global progress bar.

Returns: The created context containing the scene.

OfContext * IOHelpers::import_scene	(	OfContext &	context,
		const CoreString &	filename,
		AppProgressBar *	load_progress_bar = `nullptr`
	)

static

Import a scene from the specified filename.

Parameters

context	Context that will contain the imported scene.
filename	Scene filename.
load_progress_bar	Optional global progress bar.

Returns: The created context containing the scene.

bool IOHelpers::import_scene	(	OfContext &	import_context,
		const CoreString &	filename,
		CoreVector< OfObject * > &	imported_objects
	)

static

Imports the items of a scene into the specified context.

Contrary to the other import_scene functions, this function does not create a new context containing the created items. Created items can be accessed via the specified vector.

Parameters

import_context	Context in which the scene items will be created.
filename	Scene filename.
imported_objects	Objects that have been created into the import context when importing the scene.

Returns: True if the scene file was successfully imported.

bool IOHelpers::import_texture	(	AppObject &	app,
		const CoreString &	filename,
		const CoreString &	class_name,
		const CoreString &	suffix,
		OfObject *&	texture
	)

static

Import one texture from the specified filename.

Parameters

[in]	app	Application object
[in]	filename	Image filename
[out]	texture	OfObject texture is that were created after import

Returns: True if successful

bool IOHelpers::import_texture	(	OfContext &	context,
		const CoreString &	filename,
		const CoreString &	class_name,
		const CoreString &	suffix,
		OfObject *&	texture
	)

static

Import one texture from the specified filename.

Parameters

[in]	context	Context that will contain the imported texture
[in]	filename	Image filename
[out]	texture	OfObject texture is that were created after import

Returns: True if successful

bool IOHelpers::import_textures	(	AppObject &	app,
		const CoreBasicArray< CoreString > &	filenames,
		const CoreString &	class_name,
		const CoreString &	suffix,
		CoreVector< OfObject * > &	textures
	)

static

Import one or multiple textures from the specified filename.

Parameters

[in]	app	Application object
[in]	filenames	Image filenames
[out]	textures	OfObject textures is that were created after import

Returns: True if successful

bool IOHelpers::import_textures	(	OfContext &	context,
		const CoreBasicArray< CoreString > &	filenames,
		const CoreString &	class_name,
		const CoreString &	suffix,
		CoreVector< OfObject * > &	textures
	)

static

Import one or multiple textures from the specified filename.

Parameters

[in]	context	Context that will contain the imported textures
[in]	filenames	Image filenames
[out]	textures	OfObject textures is that were created after import

Returns: True if successful

OfContext * IOHelpers::import_volume	(	AppObject &	app,
		const CoreString &	filename
	)

static

Import a volume from the specified filename.

Parameters

[in]	app	Application object
[in]	filename	Volume filename

Returns: The created context containing the volume

OfContext * IOHelpers::import_volume	(	OfContext &	context,
		const CoreString &	filename
	)

static

Import a volume from the specified filename.

Parameters

[in]	context	Context that will contain the imported volume
[in]	filename	Volume filename

Returns: The created context containing the volume

OfContext * IOHelpers::import_volumes	(	AppObject &	app,
		const CoreBasicArray< CoreString > &	filenames
	)

static

Import one or multiple volumes from the specified filename.

Parameters

[in]	app	Application object
[in]	filenames	Volume filenames

Returns: The created context containing the volume

OfContext * IOHelpers::import_volumes	(	OfContext &	context,
		const CoreBasicArray< CoreString > &	filenames
	)

static

Import one or multiple volumes from the specified filename.

Parameters

[in]	context	Context that will contain the imported volume
[in]	filenames	Volume filenames

Returns: The created context containing the volume

bool IOHelpers::move_particles_absolute	(	OfObject &	object,
		const CoreBasicArray< unsigned long > &	indices,
		const CoreBasicArray< GMathVec3f > &	positions
	)

static

Set position of some particles within a particle container from the specified arguments.

Parameters

[in]	object	Particle container
[in]	indices	Array of particle indices to set
[in]	positions	Array of positions

Returns: True if successful

bool IOHelpers::move_particles_relative	(	OfObject &	object,
		const CoreSet< unsigned long > &	indices,
		const GMathVec3f &	delta,
		unsigned short	space
	)

static

Move some particles within a particle container from the specified arguments.

Parameters

[in]	object	Particle container
[in]	indices	Set of particle indices to move
[in]	delta	value to add in given space
[in]	space	space (world,object,local) in which value is expressed

Returns: True if successful

OfContext * IOHelpers::pick_context	(	GuiApp &	app,
		const CoreString &	title = `""`
	)

static

Popup the browser picker and return the selected OfContext.

Parameters

[in]	app	application
[in]	title	set the title bar of the browser window

OfContext * IOHelpers::pick_context	(	GuiApp &	app,
		const OfContext &	path,
		const CoreString &	title = `""`
	)

static

Popup the browser picker and return the selected OfContext.

Parameters

[in]	app	application
[in]	path	set the context for which the browser should display its content
[in]	title	set the title bar of the browser window

void IOHelpers::pick_contexts	(	GuiApp &	app,
		CoreVector< OfContext * > &	selection,
		const CoreString &	title = `""`
	)

static

Popup the browser picker and return the selected OfContext items.

Parameters

[in]	app	application
[out]	selection	resulting user selection
[in]	title	set the title bar of the browser window

void IOHelpers::pick_contexts	(	GuiApp &	app,
		CoreVector< OfContext * > &	selection,
		const OfContext &	path,
		const CoreString &	title = `""`
	)

static

Popup the browser picker and return the selected OfContext items.

Parameters

[in]	app	application
[out]	selection	resulting user selection
[in]	path	set the context for which the browser should display its content
[in]	title	set the title bar of the browser window

OfItem * IOHelpers::pick_item	(	GuiApp &	app,
		const CoreBasicArray< CoreString > &	filter_classes,
		const CoreString &	title = `""`
	)

static

Popup the browser picker and return the selected OfItem.

Parameters

[in]	app	application
[in]	filter_classes	the browser displays only items matching the specified classes
[in]	title	set the title bar of the browser window

OfItemHandle IOHelpers::pick_item	(	GuiApp &	app,
		const CoreBasicArray< CoreString > &	filter_classes,
		const OfContext &	path,
		const CoreString &	title = `""`
	)

static

Popup the browser picker and return the selected OfItem.

Parameters

[in]	app	application
[in]	filter_classes	the browser displays only items matching the specified classes
[in]	path	set the context for which the browser should display its content
[in]	title	set the title bar of the browser window

void IOHelpers::pick_items	(	GuiApp &	app,
		CoreVector< OfItemHandle > &	selection,
		const CoreBasicArray< CoreString > &	filter_classes,
		const CoreString &	title = `""`
	)

static

Popup the browser picker and return the selected OfItem items.

Parameters

[in]	app	application
[out]	selection	resulting user selection
[in]	filter_classes	the browser displays only items matching the specified classes
[in]	title	set the title bar of the browser window

void IOHelpers::pick_items	(	GuiApp &	app,
		CoreVector< OfItemHandle > &	selection,
		const CoreBasicArray< CoreString > &	filter_classes,
		const OfContext &	path,
		const CoreString &	title = `""`
	)

static

Popup the browser picker and return the selected OfItem items.

Parameters

[in]	app	application
[out]	selection	resulting user selection
[in]	filter_classes	the browser displays only items matching the specified classes
[in]	path	set the context for which the browser should display its content
[in]	title	set the title bar of the browser window

OfObject * IOHelpers::pick_object	(	GuiApp &	app,
		const CoreBasicArray< CoreString > &	filter_classes,
		const CoreString &	title = `""`
	)

static

Popup the browser picker and return the selected OfObject.

Parameters

[in]	app	application
[in]	filter_classes	the browser displays only items matching the specified classes
[in]	title	set the title bar of the browser window

OfObjectHandle IOHelpers::pick_object	(	GuiApp &	app,
		const CoreBasicArray< CoreString > &	filter_classes,
		const OfContext &	path,
		const CoreString &	title = `""`
	)

static

Popup the browser picker and return the selected OfObject.

Parameters

[in]	app	application
[in]	filter_classes	the browser displays only items matching the specified classes
[in]	path	set the context for which the browser should display its content
[in]	title	set the title bar of the browser window

void IOHelpers::pick_objects	(	GuiApp &	app,
		CoreVector< OfObjectHandle > &	selection,
		const CoreBasicArray< CoreString > &	filter_classes,
		const CoreString &	title = `""`
	)

static

Popup the browser picker and return the selected OfObject items.

Parameters

[in]	app	application
[out]	selection	resulting user selection
[in]	filter_classes	the browser displays only items matching the specified classes
[in]	title	set the title bar of the browser window

void IOHelpers::pick_objects	(	GuiApp &	app,
		CoreVector< OfObjectHandle > &	selection,
		const CoreBasicArray< CoreString > &	filter_classes,
		const OfContext &	path,
		const CoreString &	title = `""`
	)

static

Popup the browser picker and return the selected OfObject items.

Parameters

[in]	app	application
[out]	selection	resulting user selection
[in]	filter_classes	the browser displays only items matching the specified classes
[in]	path	set the context for which the browser should display its content
[in]	title	set the title bar of the browser window

OfItemHandle IOHelpers::pick_source_for_selection	(	GuiApp &	app,
		const CoreVector< OfItemHandle > &	selection
	)

static

Popup the browser picker and return the selected OfObject that can be used as source for current selection.

Parameters

[in]	app	application
[in]	selection	instances candidates to choose a source for

OfContext * IOHelpers::reference_asset	(	AppObject &	app,
		const CoreString &	filename
	)

static

Reference an asset from the specified filename.

Parameters

[in]	app	Application object
[in]	filename	Asset filename

Returns: The created context containing the asset

Note: Deprecated and not undoable, use reference_file instead

OfContext * IOHelpers::reference_asset	(	OfContext &	context,
		const CoreString &	filename
	)

static

Reference an asset from the specified filename.

Parameters

[in]	working_context	Context that will contain the imported asset
[in]	filename	Asset filename

Returns: The created context containing the asset

Note: Deprecated and not undoable, use reference_file instead

bool IOHelpers::reference_export_context	(	AppObject &	app,
		OfContext &	context,
		const CoreString &	filename
	)

static

Export a context to the specified project filename.

Parameters

[in]	app	Application object
[in]	context	Context
[in]	filenames	project filename

Returns: True if successful

bool IOHelpers::reference_file	(	OfContext &	working_context,
		const CoreBasicArray< CoreString > &	filenames
	)

static

Reference files from the specified filenames.

Parameters

[in]	working_context	Context that will contain the referenced assets
[in]	filenames	Asset filenames

Returns: True if successful

Note: Soon deprecated, you may use reference_files instead, which returns the contexts that have been created

OfContext * IOHelpers::reference_file	(	OfContext &	working_context,
		const CoreString &	filename
	)

static

Reference a file from the specified filename.

Parameters

[in]	working_context	Context that will contain the referenced asset
[in]	filename	Asset filename

Returns: The created reference context containing the file

bool IOHelpers::reference_files	(	OfContext &	working_context,
		const CoreBasicArray< CoreString > &	filenames,
		CoreVector< OfContext * > &	refs
	)

static

Reference files from the specified filenames.

Parameters

[in]	working_context	Context that will contain the referenced assets
[in]	filenames	Asset filenames
[out]	refs	Reference contexts that have been created

Returns: True if successful

void IOHelpers::reference_make_local	(	AppObject &	app,
		OfContext &	context
	)

static

Make local the specified reference.

Parameters

[in]	app	Application object
[in]	context	Context that will become local

void IOHelpers::reference_make_local	(	AppObject &	app,
		const CoreBasicArray< CoreString > &	context_paths
	)

static

Make local the specified reference paths.

Parameters

[in]	app	Application object
[in]	context_paths	Contexts that will become local

void IOHelpers::reload_resources ( AppObject & app )

static

Reload resources (Force the synchronization of resources)

Parameters

[in] app Application object

bool IOHelpers::rename_particles_property	(	OfConstObjectHandle	object,
		const CoreString &	property,
		const CoreString &	name
	)

static

Rename a property within a particle geometry.

Note: Fully supported only on GeometryParticleContainer (on other classes, the modification may be lost upon reload).

Parameters

[in]	object	Particle geometry
[in]	property	Former name of the property
[in]	name	New name of the property

Returns: True if successful

void IOHelpers::resync_resources ( AppObject & app )

static

Resynchronize resources.

Parameters

[in] app Application object

void IOHelpers::save_icon	(	OfClass &	cls,
		const CoreString &	filename,
		const int &	size = `128`
	)

static

Export a class internal icon to an output image file.

Parameters

[in]	cls	Class from which to export its icon
[in]	filename	Output image name
[in]	size	Image size in pixel; by default size = 128

bool IOHelpers::save_image	(	AppObject &	app,
		const ImageCanvas &	image,
		const CoreString &	filename,
		const ImageIOFileFormat::Save &	format,
		const CoreString &	color_space,
		const ImageIOFileFormat::OpenExrCompressionMethod &	compression_method = `ImageIOFileFormat::NO_COMPRESSION`
	)

static

Save the specified image with the specified format at the specified extension.

Parameters

[in]	app	Application object
[in]	image	image to save
[in]	filename	filename
[in]	format
[in]	color_space	convert image to the specified color space

Note: The file extension is automatically appended

Returns: True if successful

bool IOHelpers::set_particles	(	OfObject &	object,
		const CoreBasicArray< GMathVec3f > &	positions,
		const CoreBasicArray< GMathVec3f > &	normals = `CoreBasicArray<GMathVec3f>(0, 0)`,
		const CoreBasicArray< GMathVec3f > &	velocities = `CoreBasicArray<GMathVec3f>(0, 0)`
	)

static

Set a particle container from the specified arguments.

Parameters

[in]	object	Particle container
[in]	positions	Array of positions
[in]	normals	Array of normals
[in]	velocities	Array of velocities

Returns: True if successful

bool IOHelpers::set_particles_properties	(	OfObject &	object,
		const CoreBasicArray< ResourceProperty * > &	properties
	)

static

Set properties for a particle geometry from the specified arguments.

Note: Fully supported only on GeometryParticleContainer (on other classes, the modification may be lost upon reload).

Parameters

[in]	object	Particle geometry
[in]	properties	Array of properties

Returns: True if successful

bool IOHelpers::set_particles_properties	(	OfObject &	object,
		const CoreBasicArray< GeometryPointProperty * > &	properties
	)

static

Set properties for a particle geometry from the specified arguments.

Note: Fully supported only on GeometryParticleContainer (on other classes, the modification may be lost upon reload).

Parameters

[in]	object	Particle geometry
[in]	properties	Array of properties

Returns: True if successful

bool IOHelpers::set_particles_property_values	(	OfObject &	object,
		const CoreString &	property,
		unsigned int	type,
		unsigned int	dim,
		const CoreSet< unsigned long > &	indices,
		void *	values
	)

static

Edit property of some particles within a particle geometry from the specified arguments.

Note: Fully supported only on GeometryParticleContainer (on other classes, the modification may be lost upon reload).

Parameters

[in]	object	Particle geometry
[in]	property	Name of the property to edit
[in]	type	Type of value as ResourceProperty::Type
[in]	dim	Number of subvalues
[in]	indices	Array of indices to set. Empty array is a shortcut to set all values
[in]	values	buffer content depends on property definition (type & dim). Assume that the given pointer can be cast to the required type and that the buffer provides enough subvalues.

Public Types

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation