Visualization Library 2.0.0

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | List of all members
vlX::LoadWriterVLX Class Reference

A vl::ResourceLoadWriter capable of reading Visualization Library's VLT and VLB files. More...

#include <ioVLX.hpp>

+ Inheritance diagram for vlX::LoadWriterVLX:

Public Member Functions

 LoadWriterVLX ()
 
vl::ref< vl::ResourceDatabaseloadResource (const vl::String &path) const
 
vl::ref< vl::ResourceDatabaseloadResource (vl::VirtualFile *file) const
 
bool writeResource (const vl::String &path, vl::ResourceDatabase *res_db) const
 
bool writeResource (vl::VirtualFile *file, vl::ResourceDatabase *res_db) const
 
- Public Member Functions inherited from vl::ResourceLoadWriter
 ResourceLoadWriter (const String &load_extensions, const String &write_extensions)
 
bool canLoad (const String &extension) const
 Returns true if the given file type can be loaded. More...
 
const StringloadExtensions () const
 Returns the string containing the file types that can be loaded. More...
 
void setLoadExtensions (const String &extensions)
 Sets the set of file extensions that can be loaded. More...
 
bool canWrite (const String &extension) const
 Returns true if the given file type can be written. More...
 
const StringwriteExtensions () const
 Returns the string containing the file types that can be written. More...
 
void setWriteExtensions (const String &extensions)
 Sets the set of file extensions that can be written. More...
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 
- Protected Attributes inherited from vl::ResourceLoadWriter
String mLoadExtensions
 
String mWriteExtensions
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Detailed Description

A vl::ResourceLoadWriter capable of reading Visualization Library's VLT and VLB files.

Definition at line 67 of file ioVLX.hpp.

Constructor & Destructor Documentation

◆ LoadWriterVLX()

vlX::LoadWriterVLX::LoadWriterVLX ( )
inline

Definition at line 72 of file ioVLX.hpp.

Member Function Documentation

◆ loadResource() [1/2]

vl::ref<vl::ResourceDatabase> vlX::LoadWriterVLX::loadResource ( const vl::String path) const
inlinevirtual

Implements vl::ResourceLoadWriter.

Definition at line 74 of file ioVLX.hpp.

References vlX::isVLB(), vlX::isVLT(), vlX::loadVLB(), vlX::loadVLT(), and NULL.

◆ loadResource() [2/2]

vl::ref<vl::ResourceDatabase> vlX::LoadWriterVLX::loadResource ( vl::VirtualFile file) const
inlinevirtual

Implements vl::ResourceLoadWriter.

Definition at line 85 of file ioVLX.hpp.

References vlX::isVLB(), vlX::isVLT(), vlX::loadVLB(), vlX::loadVLT(), and NULL.

◆ writeResource() [1/2]

bool vlX::LoadWriterVLX::writeResource ( const vl::String path,
vl::ResourceDatabase res_db 
) const
inlinevirtual

◆ writeResource() [2/2]

bool vlX::LoadWriterVLX::writeResource ( vl::VirtualFile file,
vl::ResourceDatabase res_db 
) const
inlinevirtual

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