HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
FS_FileResolverOptions Class Reference

Provides various options for creating and obtaining the file data. More...

#include <FS_FileResolver.h>

Public Member Functions

 FS_FileResolverOptions ()
 Constructor. More...
 
 FS_FileResolverOptions (const FS_FileResolverOptions &src)
 
const FS_FileResolverOptionsoperator= (const FS_FileResolverOptions &src)
 Assignment operator. More...
 
fpreal getTime () const
 Gets the time at which a node should be evaluated to obtain the data. More...
 
void setTime (fpreal time)
 
const UT_StringHoldergetFileExtension () const
 
void setFileExtension (const UT_StringHolder &ext)
 
bool getIsEnvMap () const
 Checks if the file should be treated as an environment map. More...
 
void setIsEnvMap (bool env_map)
 

Detailed Description

Provides various options for creating and obtaining the file data.

Definition at line 48 of file FS_FileResolver.h.

Constructor & Destructor Documentation

FS_FileResolverOptions::FS_FileResolverOptions ( )

Constructor.

FS_FileResolverOptions::FS_FileResolverOptions ( const FS_FileResolverOptions src)

Member Function Documentation

const UT_StringHolder& FS_FileResolverOptions::getFileExtension ( ) const
inline

Gets the extension for the file that will contain the resolved data. It indirectly determines the data type for stream readers and writers.

Definition at line 67 of file FS_FileResolver.h.

bool FS_FileResolverOptions::getIsEnvMap ( ) const
inline

Checks if the file should be treated as an environment map.

Definition at line 73 of file FS_FileResolver.h.

fpreal FS_FileResolverOptions::getTime ( ) const
inline

Gets the time at which a node should be evaluated to obtain the data.

Definition at line 60 of file FS_FileResolver.h.

const FS_FileResolverOptions& FS_FileResolverOptions::operator= ( const FS_FileResolverOptions src)

Assignment operator.

void FS_FileResolverOptions::setFileExtension ( const UT_StringHolder ext)
inline

Definition at line 69 of file FS_FileResolver.h.

void FS_FileResolverOptions::setIsEnvMap ( bool  env_map)
inline

Definition at line 75 of file FS_FileResolver.h.

void FS_FileResolverOptions::setTime ( fpreal  time)
inline

Definition at line 62 of file FS_FileResolver.h.


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