Class for passing IO related options to vsg::read/write calls. More...

#include <Options.h>

Inheritance diagram for vsg::Options:

Collaboration diagram for vsg::Options:

[legend]

Public Types
enum	FindFileHint { CHECK_ORIGINAL_FILENAME_EXISTS_FIRST , CHECK_ORIGINAL_FILENAME_EXISTS_LAST , ONLY_CHECK_PATHS }
	Hint to use when searching for Paths with vsg::findFile(filename, options);. More...

using	FindFileCallback = std::function< Path(const Path &filename, const Options *options)>

Public Member Functions
	Options (const Options &options)

template<typename... Args>
	Options (Args... args)

Options &	operator= (const Options &rhs)=delete

virtual bool	readOptions (CommandLine &arguments)
	read command line options, assign values to this options object to later use with reading/writing files

void	read (Input &input) override

void	write (Output &output) const override

void	add (ref_ptr< ReaderWriter > rw={})

void	add (const ReaderWriters &rws)

Public Member Functions inherited from vsg::Inherit< Object, Options >
	Inherit (Args &&... args)

std::size_t	sizeofObject () const noexcept override

const char *	className () const noexcept override

const std::type_info &	type_info () const noexcept override

bool	is_compatible (const std::type_info &type) const noexcept override

int	compare (const Object &rhs) const override

void	accept (Visitor &visitor) override

void	accept (ConstVisitor &visitor) const override

void	accept (RecordTraversal &visitor) const override

Public Member Functions inherited from vsg::Object
	Object (const Object &)

Object &	operator= (const Object &)

template<class T >
T *	cast ()

template<class T >
const T *	cast () const

virtual void	traverse (Visitor &)

virtual void	traverse (ConstVisitor &) const

virtual void	traverse (RecordTraversal &) const

void	ref () const noexcept

void	unref () const noexcept

void	unref_nodelete () const noexcept

unsigned int	referenceCount () const noexcept

template<typename T >
void	setValue (const std::string &key, const T &value)

void	setValue (const std::string &key, const char *value)
	specialization of setValue to handle passing c strings

template<typename T >
bool	getValue (const std::string &key, T &value) const
	get specified value type, return false if value associated with key is not assigned or is not the correct type

void	setObject (const std::string &key, ref_ptr< Object > object)
	assign an Object associated with key

Object *	getObject (const std::string &key)
	get Object pointer associated with key, return nullptr if no object associated with key has been assigned

const Object *	getObject (const std::string &key) const
	get const Object pointer associated with key, return nullptr if no object associated with key has been assigned

template<class T >
T *	getObject (const std::string &key)
	get object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned

template<class T >
const T *	getObject (const std::string &key) const
	get const object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned

ref_ptr< Object >	getRefObject (const std::string &key)
	get ref_ptr<Object> associated with key, return nullptr if no object associated with key has been assigned

ref_ptr< const Object >	getRefObject (const std::string &key) const
	get ref_ptr<const Object> pointer associated with key, return nullptr if no object associated with key has been assigned

template<class T >
ref_ptr< T >	getRefObject (const std::string &key)
	get ref_ptr<T> of specified type associated with key, return nullptr if no object associated with key has been assigned

template<class T >
const ref_ptr< const T >	getRefObject (const std::string &key) const
	get ref_ptr<const T> of specified type associated with key, return nullptr if no object associated with key has been assigned

void	removeObject (const std::string &key)
	remove meta object or value associated with key

Auxiliary *	getOrCreateAuxiliary ()

Auxiliary *	getAuxiliary ()

const Auxiliary *	getAuxiliary () const

Public Attributes
ref_ptr< SharedObjects >	sharedObjects

ReaderWriters	readerWriters

ref_ptr< OperationThreads >	operationThreads

FindFileHint	checkFilenameHint = CHECK_ORIGINAL_FILENAME_EXISTS_FIRST

Paths	paths

FindFileCallback	findFileCallback

Path	fileCache

Path	extensionHint

bool	mapRGBtoRGBAHint = true

CoordinateConvention	sceneCoordinateConvention = CoordinateConvention::Z_UP
	Coordinate convention to use for scene graph.

std::map< Path, CoordinateConvention >	formatCoordinateConventions
	Coordinate convention to assume for specified lower case file formats extensions.

std::map< std::string, ref_ptr< ShaderSet > >	shaderSets

Additional Inherited Members
Static Public Member Functions inherited from vsg::Inherit< Object, Options >
static ref_ptr< Options >	create (Args &&... args)

static ref_ptr< Options >	create_if (bool flag, Args &&... args)

Static Public Member Functions inherited from vsg::Object
static ref_ptr< Object >	create ()

static ref_ptr< Object >	create_if (bool flag)

static void *	operator new (std::size_t count)
	provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_AFFINTY_OBJECTS

static void	operator delete (void *ptr)

Protected Member Functions inherited from vsg::Object
virtual void	_attemptDelete () const

void	setAuxiliary (Auxiliary *auxiliary)

Detailed Description

Class for passing IO related options to vsg::read/write calls.

Member Enumeration Documentation

◆ FindFileHint

enum vsg::Options::FindFileHint

Hint to use when searching for Paths with vsg::findFile(filename, options);.

Enumerator

CHECK_ORIGINAL_FILENAME_EXISTS_LAST

check the filename exists with it's original path before trying to find it in Options::paths.

ONLY_CHECK_PATHS

check the filename exists with it's original path after failing to find it in Options::paths.

only check the filename exists in the Options::paths

Member Data Documentation

◆ shaderSets

std::map<std::string, ref_ptr<ShaderSet> > vsg::Options::shaderSets

User defined ShaderSet map, loaders should check the available ShaderSet used the name of the type ShaderSet. Standard names are : "pbr" will substitute for vsg::createPhysicsBasedRenderingShaderSet() "phong" will substitute for vsg::createPhongShaderSet() "flat" will substitute for vsg::createFlatShadedShaderSet() "text" will substitute for vsg::createTextShaderSet()

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

include/vsg/io/Options.h

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FindFileHint

Member Data Documentation

◆ shaderSets