vsg 1.1.10
VulkanSceneGraph library
|
Class for passing IO related options to vsg::read/write calls. More...
#include <Options.h>
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 &rhs, const CopyOp ©op={}) | |
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 | add (ref_ptr< ReaderWriter > rw={}) |
void | add (const ReaderWriters &rws) |
ref_ptr< Object > | clone (const CopyOp ©op={}) const override |
int | compare (const Object &rhs) const override |
compare two objects, return -1 if this object is less than rhs, return 0 if it's equal, return 1 if rhs is greater, | |
void | read (Input &input) override |
void | write (Output &output) const override |
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 |
void | accept (Visitor &visitor) override |
Public Member Functions inherited from vsg::Object | |
Object (const Object &object, const CopyOp ©op={}) | |
Object & | operator= (const Object &) |
template<class T> | |
T * | cast () |
template<class T> | |
const T * | cast () const |
virtual void | traverse (Visitor &) |
virtual void | accept (ConstVisitor &visitor) const |
virtual void | traverse (ConstVisitor &) const |
virtual void | accept (RecordTraversal &visitor) 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 |
StateCommands | inheritedState |
ref_ptr< Instrumentation > | instrumentation |
Hook for assigning Instrumentation to enable profiling of record traversal. | |
ref_ptr< FindDynamicObjects > | findDynamicObjects |
mechanism for finding dynamic objects in loaded scene graph | |
ref_ptr< PropagateDynamicObjects > | propagateDynamicObjects |
mechanism for propogating dynamic objects classification up parental chain so that cloning is done on all dynamic objects to avoid sharing of dyanmic parts. |
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) |
Class for passing IO related options to vsg::read/write calls.
Hint to use when searching for Paths with vsg::findFile(filename, options);.
clone this object using CopyOp's duplicates map to decide whether to clone or to return the original object. The default clone(CopyOp&) implementation simply returns ref_ptr<> to this object rather attempt to clone.
Reimplemented from vsg::Object.
|
overridevirtual |
compare two objects, return -1 if this object is less than rhs, return 0 if it's equal, return 1 if rhs is greater,
Reimplemented from vsg::Inherit< Object, Options >.
|
overridevirtual |
Reimplemented from vsg::Object.
|
overridevirtual |
Reimplemented from vsg::Object.
StateCommands vsg::Options::inheritedState |
specification of any StateCommands that will be provided the parents of any newly created subgraphs scene graph creation routines can use the inherited state information to avoid setting state in the local subgraph.
User defined ShaderSet map, loaders should check the available ShaderSet using the name of the type of 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()