The agxIO namespace contains classes for reading, writing and finding files. More...

Classes
class	ArgumentParser
	A small argument parser class. More...

class	Environment
	Class for setting search path for locating dynamic libraries, scripts etc. More...

struct	FileExtension
	Support mesh file formats. More...

class	FilePathContainer
	class for locating files More...

class	FileState
	Class for storing and comparing a change date for a file on disk. More...

class	FileStateVector
	vector for holding a set of file states, where the vector can be asked if any of the files has been changed. More...

struct	FileSystem

class	Image
	Class to represent Images. More...

class	ImageReader
	Base class for ImageReaders. More...

class	ImageReaderPNG
	ImageReader for png-files. More...

class	KeyEvent

class	MeshReader
	Class for reading a mesh object from file and extracting vertices, normals and indices for collision detection Notice that this class will read the mesh vertices/indices as is. More...

class	MeshReaderOBJ
	Class for reading a Wavefront OBJ file. More...

class	PNGImageValueInterpreter

class	PovExporter
	Class for exporting a simulation into AGX .pov format. More...

class	ResourceManager

Typedefs
typedef agx::ref_ptr< ArgumentParser >	ArgumentParserRef

typedef float(*	GetValueFunction) (float val)

typedef agx::observer_ptr< const Image >	ImageConstObserver

typedef agx::ref_ptr< const Image >	ImageConstRef

typedef agx::observer_ptr< Image >	ImageObserver

typedef agx::ref_ptr< ImageReaderPNG >	ImageReaderPNGRef

typedef agx::ref_ptr< ImageReader >	ImageReaderRef

typedef agx::ref_ptr< Image >	ImageRef

typedef agx::Event2< int, EventType >	InputEvent

typedef agx::observer_ptr< const KeyEvent >	KeyEventConstObserver

typedef agx::ref_ptr< const KeyEvent >	KeyEventConstRef

typedef agx::observer_ptr< KeyEvent >	KeyEventObserver

typedef agx::ref_ptr< KeyEvent >	KeyEventRef

typedef agx::observer_ptr< const MeshReader >	MeshReaderConstObserver

typedef agx::ref_ptr< const MeshReader >	MeshReaderConstRef

typedef agx::ref_ptr< MeshReaderOBJ >	MeshReaderOBJRef

typedef agx::observer_ptr< MeshReader >	MeshReaderObserver

typedef agx::ref_ptr< MeshReader >	MeshReaderRef

typedef agx::Event3< MouseButton, EventType, agx::Vec2 >	MouseEvent

typedef agx::ref_ptr< PNGImageValueInterpreter >	PNGImageValueInterpreterRef

typedef float(*	ReadValue01Function) (agxIO::Image *image, size_t x, size_t y)

typedef agx::observer_ptr< const ResourceManager >	ResourceManagerConstObserver

typedef agx::ref_ptr< const ResourceManager >	ResourceManagerConstRef

typedef agx::observer_ptr< ResourceManager >	ResourceManagerObserver

typedef agx::ref_ptr< ResourceManager >	ResourceManagerRef

Enumerations
enum	EventType { EVENT_DOWN , EVENT_UP }

enum	FileType { FILETYPE_AGX , FILETYPE_AAGX , FILETYPE_POV }
	Specify the type of file. More...

enum	MouseButton { MOUSE_LEFT , MOUSE_RIGHT , MOUSE_MIDDLE , MOUSE_WHEELUP , MOUSE_WHEELDOWN }

Functions
template<>
bool AGXCORE_EXPORT	ArgumentParser::assignStringContent< agx::String > (const std::string &key, agx::String &type)

template<>
bool AGXCORE_EXPORT	ArgumentParser::assignStringContent< std::string > (const std::string &key, std::string &type)

AGXPHYSICS_EXPORT bool	createCompressedArchive (const agx::String &archiveName, const agx::StringVector &files)
	Function which will create a zipped file of name `archiveName` containing the files listed in `files`.

float	cubicValueFunction (float val)

AGXPHYSICS_EXPORT bool	decompressArchive (const agx::String &archiveFile, const agx::String &directory)
	Function which will de-compress an archive to a target directory.

AGXCORE_EXPORT bool	getRegisterValue (const char *key, agx::String &value)
	Get a string value from the registry written by the Installer.

float	linearValueFunction (float val)

AGXCORE_EXPORT bool	packZipFile (const agx::String &zipFilePath, const agx::StringVector &fileList, agx::UInt compression=6)

float	quadraticValueFunction (float val)

AGXCORE_EXPORT char *	readBinaryFile (size_t *size, const agx::String &filePath)
	Read the content of a file into a char array allocated by the function.

void AGXCORE_EXPORT	readFile (agx::String &result, const agx::String &filePath)

AGXPHYSICS_EXPORT bool	readFile (const agx::String &filename, agxSDK::Simulation simulation, agxSDK::Assembly parent=nullptr, agx::UInt selection=agxSDK::Simulation::READ_DEFAULT)
	Utility function for reading various files:

float	readFourChannelMergedValue01 (agxIO::Image *image, size_t x, size_t y)

float	readOneOrTwoChannelValue01 (agxIO::Image *image, size_t x, size_t y)

float	readSingleChannelValue01 (agxIO::Image *image, size_t x, size_t y, size_t channel)

float	readThreeChannelMergedValue01 (agxIO::Image *image, size_t x, size_t y)

void AGXCORE_EXPORT	registerKeyboardCallback (int key, InputEvent::CallbackType *callback)

void AGXCORE_EXPORT	registerMouseCallback (MouseEvent::CallbackType *callback)

void AGXCORE_EXPORT	triggerKeyboardEvent (int key, EventType type)

void AGXCORE_EXPORT	triggerMouseEvent (MouseButton button, EventType type, const agx::Vec2 &pos)

AGXCORE_EXPORT bool	unpackZipFile (const agx::String &zipFilePath, const agx::String &targetDirectoryPath)

void AGXCORE_EXPORT	unregisterMouseCallback (MouseEvent::CallbackType *callback)

AGXPHYSICS_EXPORT bool	writeFile (const agx::String &filename, agxSDK::Simulation *simulation, agx::Vec3 from=agx::Vec3(), agx::Vec3 at=agx::Vec3(), agx::Vec3 up=agx::Vec3(), double fovy=0, double aspectRatio=0)
	Utility function for write a simulation into various files:

AGXPHYSICS_EXPORT bool	writeFile (FileType type, std::ostream &outStream, agxSDK::Simulation *simulation, agx::Vec3 from=agx::Vec3(), agx::Vec3 at=agx::Vec3(), agx::Vec3 up=agx::Vec3(), double fovy=0, double aspectRatio=0)
	Utility function for write a simulation to a stream.

void	writeSingleChannelValue01 (unsigned char val, agxIO::Image *image, size_t x, size_t y, size_t channel)

Detailed Description

The agxIO namespace contains classes for reading, writing and finding files.

Typedef Documentation

◆ ArgumentParserRef

typedef agx::ref_ptr<ArgumentParser> agxIO::ArgumentParserRef

Definition at line 300 of file ArgumentParser.h.

◆ GetValueFunction

typedef float(* agxIO::GetValueFunction) (float val)

Definition at line 25 of file ImageValueInterpreter.h.

◆ ImageConstObserver

typedef agx::observer_ptr< const Image > agxIO::ImageConstObserver

Definition at line 28 of file Image.h.

◆ ImageConstRef

typedef agx::ref_ptr< const Image > agxIO::ImageConstRef

Definition at line 28 of file Image.h.

◆ ImageObserver

typedef agx::observer_ptr< Image > agxIO::ImageObserver

Definition at line 28 of file Image.h.

◆ ImageReaderPNGRef

typedef agx::ref_ptr<ImageReaderPNG> agxIO::ImageReaderPNGRef

Definition at line 47 of file ImageReaderPNG.h.

◆ ImageReaderRef

typedef agx::ref_ptr<ImageReader> agxIO::ImageReaderRef

Definition at line 41 of file ImageReader.h.

◆ ImageRef

typedef agx::ref_ptr< Image > agxIO::ImageRef

Definition at line 28 of file Image.h.

◆ InputEvent

typedef agx::Event2<int, EventType> agxIO::InputEvent

Definition at line 44 of file Events.h.

◆ KeyEventConstObserver

typedef agx::observer_ptr< const KeyEvent > agxIO::KeyEventConstObserver

Definition at line 27 of file KeyEvent.h.

◆ KeyEventConstRef

typedef agx::ref_ptr< const KeyEvent > agxIO::KeyEventConstRef

Definition at line 27 of file KeyEvent.h.

◆ KeyEventObserver

typedef agx::observer_ptr< KeyEvent > agxIO::KeyEventObserver

Definition at line 27 of file KeyEvent.h.

◆ KeyEventRef

typedef agx::ref_ptr< KeyEvent > agxIO::KeyEventRef

Definition at line 27 of file KeyEvent.h.

◆ MeshReaderConstObserver

typedef agx::observer_ptr< const MeshReader > agxIO::MeshReaderConstObserver

Definition at line 77 of file MeshReader.h.

◆ MeshReaderConstRef

typedef agx::ref_ptr< const MeshReader > agxIO::MeshReaderConstRef

Definition at line 77 of file MeshReader.h.

◆ MeshReaderOBJRef

typedef agx::ref_ptr<MeshReaderOBJ> agxIO::MeshReaderOBJRef

Definition at line 66 of file MeshReaderOBJ.h.

◆ MeshReaderObserver

typedef agx::observer_ptr< MeshReader > agxIO::MeshReaderObserver

Definition at line 77 of file MeshReader.h.

◆ MeshReaderRef

typedef agx::ref_ptr< MeshReader > agxIO::MeshReaderRef

Definition at line 77 of file MeshReader.h.

◆ MouseEvent

typedef agx::Event3<MouseButton, EventType, agx::Vec2> agxIO::MouseEvent

Definition at line 45 of file Events.h.

◆ PNGImageValueInterpreterRef

typedef agx::ref_ptr< PNGImageValueInterpreter > agxIO::PNGImageValueInterpreterRef

Definition at line 252 of file ImageValueInterpreter.h.

◆ ReadValue01Function

typedef float(* agxIO::ReadValue01Function) (agxIO::Image *image, size_t x, size_t y)

Definition at line 26 of file ImageValueInterpreter.h.

◆ ResourceManagerConstObserver

typedef agx::observer_ptr< const ResourceManager > agxIO::ResourceManagerConstObserver

Definition at line 27 of file ResourceManager.h.

◆ ResourceManagerConstRef

typedef agx::ref_ptr< const ResourceManager > agxIO::ResourceManagerConstRef

Definition at line 27 of file ResourceManager.h.

◆ ResourceManagerObserver

typedef agx::observer_ptr< ResourceManager > agxIO::ResourceManagerObserver

Definition at line 27 of file ResourceManager.h.

◆ ResourceManagerRef

typedef agx::ref_ptr< ResourceManager > agxIO::ResourceManagerRef

Definition at line 27 of file ResourceManager.h.

Enumeration Type Documentation

◆ EventType

enum agxIO::EventType

Enumerator
EVENT_DOWN
EVENT_UP

Definition at line 37 of file Events.h.

◆ FileType

enum agxIO::FileType

Specify the type of file.

Enumerator
FILETYPE_AGX
FILETYPE_AAGX
FILETYPE_POV

Definition at line 55 of file agxIO/ReaderWriter.h.

◆ MouseButton

enum agxIO::MouseButton

Enumerator
MOUSE_LEFT
MOUSE_RIGHT
MOUSE_MIDDLE
MOUSE_WHEELUP
MOUSE_WHEELDOWN

Definition at line 28 of file Events.h.

Function Documentation

◆ ArgumentParser::assignStringContent< agx::String >()

template<>

bool AGXCORE_EXPORT agxIO::ArgumentParser::assignStringContent< agx::String >	(	const std::string &	key,
		agx::String &	type
	)

◆ ArgumentParser::assignStringContent< std::string >()

template<>

bool AGXCORE_EXPORT agxIO::ArgumentParser::assignStringContent< std::string >	(	const std::string &	key,
		std::string &	type
	)

◆ createCompressedArchive()

AGXPHYSICS_EXPORT bool agxIO::createCompressedArchive	(	const agx::String &	archiveName,
		const agx::StringVector &	files
	)

Function which will create a zipped file of name archiveName containing the files listed in files.

Valid file extensions are:

.agxz (archive will contain a compressed .agx file)
.aagxz (archive will contain a compressed .aagx file)
.agxPyz (archive will contain a .agxPy file of the same name as the archive + any other files/directories with files required for the .agxPy file to run)
.mpyz (archive will contain a .agx file of the same name as the archive + one or more .mpy files)

Parameters

archiveName	- Name of created archive
files	- List of file to be compressed into archive

Returns: true if the archive is successfully created and the list of files contains the above listed ones.

◆ cubicValueFunction()

float agxIO::cubicValueFunction ( float val )

inline

Definition at line 38 of file ImageValueInterpreter.h.

◆ decompressArchive()

AGXPHYSICS_EXPORT bool agxIO::decompressArchive	(	const agx::String &	archiveFile,
		const agx::String &	directory
	)

Function which will de-compress an archive to a target directory.

.agxz (archive need to contain a compressed .agx file)
.aagxz (archive need to contain a compressed .aagx file)
.agxPyz (archive need to contain a .agxPy file of the same name as the archive + any other files/directories with files required for the .agxPy file to run)
.mpyz (archive need to contain a .agx file of the same name as the archive + one or more .mpy files)

Parameters

archiveFile	- Name of zipped archive
directory	- Path to where files are unzipped.

Returns: true if files are successfully unzipped and contains the files as listed above

◆ getRegisterValue()

AGXCORE_EXPORT bool agxIO::getRegisterValue	(	const char *	key,
		agx::String &	value
	)

Get a string value from the registry written by the Installer.

Parameters

key	- Name of the key
value	- At success, the value will contain the string content of the key.

Returns: true if the key exist and is of type string and we have read access to it.

◆ linearValueFunction()

float agxIO::linearValueFunction ( float val )

inline

Definition at line 28 of file ImageValueInterpreter.h.

◆ packZipFile()

AGXCORE_EXPORT bool agxIO::packZipFile	(	const agx::String &	zipFilePath,
		const agx::StringVector &	fileList,
		agx::UInt	compression = `6`
	)

◆ quadraticValueFunction()

float agxIO::quadraticValueFunction ( float val )

inline

Definition at line 33 of file ImageValueInterpreter.h.

◆ readBinaryFile()

AGXCORE_EXPORT char * agxIO::readBinaryFile	(	size_t *	size,
		const agx::String &	filePath
	)

Read the content of a file into a char array allocated by the function.

Ownership of the array is passed to the caller, who then becomes responsible for calling 'delete []' on it.

◆ readFile() [1/2]

void AGXCORE_EXPORT agxIO::readFile	(	agx::String &	result,
		const agx::String &	filePath
	)

◆ readFile() [2/2]

AGXPHYSICS_EXPORT bool agxIO::readFile	(	const agx::String &	filename,
		agxSDK::Simulation *	simulation,
		agxSDK::Assembly *	parent = `nullptr`,
		agx::UInt	selection = `agxSDK::Simulation::READ_DEFAULT`
	)

Utility function for reading various files:

.agx/.aagx (serialization of simulations)

The file will be searched for using AGX_ENVIRONMENT().getFilePath(agxIO::Environment::RESOURCE_PATH).find() which means that it will use the AGX_FILE_PATH environment variable and path's added to the RESOURCE_PATH.

The data will be added to the simulation given as an argument

Parameters

filename	- Filename to be opened and read
simulation	- The simulation where the content of the data will be added
parent	- If specified (!= nullptr) all objects will be added to this parent
selection	- Selection of things to read from file. See agxSDK::Simulation::ReadSelectionMask. Only for .agx or .aagx.

Returns: true if reading was successful.

◆ readFourChannelMergedValue01()

float agxIO::readFourChannelMergedValue01	(	agxIO::Image *	image,
		size_t	x,
		size_t	y
	)

inline

Definition at line 58 of file ImageValueInterpreter.h.

References agxIO::Image::getData(), and agxIO::Image::getWidth().

◆ readOneOrTwoChannelValue01()

float agxIO::readOneOrTwoChannelValue01	(	agxIO::Image *	image,
		size_t	x,
		size_t	y
	)

inline

Definition at line 43 of file ImageValueInterpreter.h.

References agxIO::Image::getChannels(), agxIO::Image::getData(), and agxIO::Image::getWidth().

◆ readSingleChannelValue01()

float agxIO::readSingleChannelValue01	(	agxIO::Image *	image,
		size_t	x,
		size_t	y,
		size_t	channel
	)

inline

Definition at line 66 of file ImageValueInterpreter.h.

References agxIO::Image::getChannels(), agxIO::Image::getData(), and agxIO::Image::getWidth().

◆ readThreeChannelMergedValue01()

float agxIO::readThreeChannelMergedValue01	(	agxIO::Image *	image,
		size_t	x,
		size_t	y
	)

inline

Definition at line 50 of file ImageValueInterpreter.h.

References agxIO::Image::getData(), and agxIO::Image::getWidth().

◆ registerKeyboardCallback()

void AGXCORE_EXPORT agxIO::registerKeyboardCallback	(	int	key,
		InputEvent::CallbackType *	callback
	)

◆ registerMouseCallback()

void AGXCORE_EXPORT agxIO::registerMouseCallback ( MouseEvent::CallbackType * callback )

◆ triggerKeyboardEvent()

void AGXCORE_EXPORT agxIO::triggerKeyboardEvent	(	int	key,
		EventType	type
	)

◆ triggerMouseEvent()

void AGXCORE_EXPORT agxIO::triggerMouseEvent	(	MouseButton	button,
		EventType	type,
		const agx::Vec2 &	pos
	)

◆ unpackZipFile()

AGXCORE_EXPORT bool agxIO::unpackZipFile	(	const agx::String &	zipFilePath,
		const agx::String &	targetDirectoryPath
	)

◆ unregisterMouseCallback()

void AGXCORE_EXPORT agxIO::unregisterMouseCallback ( MouseEvent::CallbackType * callback )

◆ writeFile() [1/2]

AGXPHYSICS_EXPORT bool agxIO::writeFile	(	const agx::String &	filename,
		agxSDK::Simulation *	simulation,
		agx::Vec3	from = `agx::Vec3()`,
		agx::Vec3	at = `agx::Vec3()`,
		agx::Vec3	up = `agx::Vec3()`,
		double	fovy = `0`,
		double	aspectRatio = `0`
	)

Utility function for write a simulation into various files:

.agx/.aagx (serialization of simulations)
.pov (Povray format)

Parameters

filename	- Filename that will contain the simulation
simulation	- The simulation containing the objects to be written to file
from	- Camera position (only for .pov format)
at	- Camera looking at point (only for .pov format)
up	- Camera up direction (only for .pov format)
fovy	- Field of view (only for .pov format)
aspectRatio	ratio for the window size (only for .pov format)

Returns: true if writing was successful.

◆ writeFile() [2/2]

AGXPHYSICS_EXPORT bool agxIO::writeFile	(	FileType	type,
		std::ostream &	outStream,
		agxSDK::Simulation *	simulation,
		agx::Vec3	from = `agx::Vec3()`,
		agx::Vec3	at = `agx::Vec3()`,
		agx::Vec3	up = `agx::Vec3()`,
		double	fovy = `0`,
		double	aspectRatio = `0`
	)

Utility function for write a simulation to a stream.

Parameters

type	- Specifies in what format, the simulation will be written to the stream
outStream	- Stream that will contain the simulation
simulation	- The simulation containing the objects to be written to file
from	- Camera position (only for .pov format)
at	- Camera looking at point (only for .pov format)
up	- Camera up direction (only for .pov format)
fovy	- Field of view (only for .pov format)
aspectRatio	ratio for the window size (only for .pov format)

Returns: true if writing was successful.

◆ writeSingleChannelValue01()

void agxIO::writeSingleChannelValue01	(	unsigned char	val,
		agxIO::Image *	image,
		size_t	x,
		size_t	y,
		size_t	channel
	)

inline

Definition at line 74 of file ImageValueInterpreter.h.

References agxIO::Image::getChannels(), agxIO::Image::getData(), and agxIO::Image::getWidth().

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ ArgumentParserRef

◆ GetValueFunction

◆ ImageConstObserver

◆ ImageConstRef

◆ ImageObserver

◆ ImageReaderPNGRef

◆ ImageReaderRef

◆ ImageRef

◆ InputEvent

◆ KeyEventConstObserver

◆ KeyEventConstRef

◆ KeyEventObserver

◆ KeyEventRef

◆ MeshReaderConstObserver

◆ MeshReaderConstRef

◆ MeshReaderOBJRef

◆ MeshReaderObserver

◆ MeshReaderRef

◆ MouseEvent

◆ PNGImageValueInterpreterRef

◆ ReadValue01Function

◆ ResourceManagerConstObserver

◆ ResourceManagerConstRef

◆ ResourceManagerObserver

◆ ResourceManagerRef

Enumeration Type Documentation

◆ EventType

◆ FileType

◆ MouseButton

Function Documentation

◆ ArgumentParser::assignStringContent< agx::String >()

◆ ArgumentParser::assignStringContent< std::string >()

◆ createCompressedArchive()

◆ cubicValueFunction()

◆ decompressArchive()

◆ getRegisterValue()

◆ linearValueFunction()

◆ packZipFile()

◆ quadraticValueFunction()

◆ readBinaryFile()

◆ readFile() [1/2]

◆ readFile() [2/2]

◆ readFourChannelMergedValue01()

◆ readOneOrTwoChannelValue01()

◆ readSingleChannelValue01()

◆ readThreeChannelMergedValue01()

◆ registerKeyboardCallback()

◆ registerMouseCallback()

◆ triggerKeyboardEvent()

◆ triggerMouseEvent()

◆ unpackZipFile()

◆ unregisterMouseCallback()

◆ writeFile() [1/2]

◆ writeFile() [2/2]

◆ writeSingleChannelValue01()