RigsofRods  2023.09
Soft-body Physics Simulation
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Data Structures | Public Types | Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes
RoR::FlexBodyFileIO Class Reference
Gfx » Flex

Enables saving and loading flexbodies from/to binary file. More...

#include <FlexFactory.h>

Data Structures

struct  FlexBodyFileMetadata
 

Public Types

enum  ResultCode {
  RESULT_CODE_OK, RESULT_CODE_GENERAL_ERROR, RESULT_CODE_ERR_FOPEN_FAILED, RESULT_CODE_ERR_SIGNATURE_MISMATCH,
  RESULT_CODE_ERR_VERSION_MISMATCH, RESULT_CODE_ERR_CACHE_NUMBER_UNDEFINED, RESULT_CODE_FREAD_OUTPUT_INCOMPLETE, RESULT_CODE_FWRITE_OUTPUT_INCOMPLETE
}
 

Public Member Functions

 FlexBodyFileIO ()
 
std::vector< FlexBody * > & GetList ()
 
void AddItemToSave (FlexBody *fb)
 
FlexBodyCacheData * GetLoadedItem (unsigned index)
 
ResultCode SaveFile ()
 
ResultCode LoadFile ()
 

Static Public Attributes

static const char * SIGNATURE = "RoR FlexBody"
 
static const unsigned int FILE_FORMAT_VERSION = 1
 

Private Member Functions

void OpenFile (const char *fopen_mode)
 
void WriteToFile (void *source, size_t length)
 
void ReadFromFile (void *dest, size_t length)
 
void CloseFile ()
 
void WriteSignature ()
 
void ReadAndCheckSignature ()
 
void WriteMetadata ()
 
void ReadMetadata (FlexBodyFileMetadata *meta)
 
void WriteFlexbodyHeader (FlexBody *flexbody)
 
void ReadFlexbodyHeader (FlexBodyCacheData *flexbody)
 
void WriteFlexbodyLocatorList (FlexBody *flexbody)
 
void ReadFlexbodyLocatorList (FlexBodyCacheData *flexbody)
 
void WriteFlexbodyNormalsBuffer (FlexBody *flexbody)
 
void ReadFlexbodyNormalsBuffer (FlexBodyCacheData *flexbody)
 
void WriteFlexbodyPositionsBuffer (FlexBody *flexbody)
 
void ReadFlexbodyPositionsBuffer (FlexBodyCacheData *flexbody)
 
void WriteFlexbodyColorsBuffer (FlexBody *flexbody)
 
void ReadFlexbodyColorsBuffer (FlexBodyCacheData *flexbody)
 

Private Attributes

std::vector< FlexBody * > m_items_to_save
 
std::vector< FlexBodyCacheData > m_loaded_items
 
FILE * m_file
 
unsigned int m_fileformat_version
 
int m_cache_entry_number
 

Detailed Description

Enables saving and loading flexbodies from/to binary file.

FILE STRUCTURE:

  1. Signature
  2. Metadata
    See also
    FlexBodyFileMetadata
  3. Flexbodies a. Header
    See also
    FlexBodyRecordHeader b. Data (not present if flexbody has flags IS_FAULTY==true or IS_ENABLED==false)
    1. Locator list
    2. Positions buffer
    3. Normals buffer
    4. Colors buffer (only present if flag HAS_TEXTURE_BLEND == true)

Definition at line 97 of file FlexFactory.h.

Member Enumeration Documentation

◆ ResultCode

enum RoR::FlexBodyFileIO::ResultCode
Enumerator
RESULT_CODE_OK 
RESULT_CODE_GENERAL_ERROR 
RESULT_CODE_ERR_FOPEN_FAILED 
RESULT_CODE_ERR_SIGNATURE_MISMATCH 
RESULT_CODE_ERR_VERSION_MISMATCH 
RESULT_CODE_ERR_CACHE_NUMBER_UNDEFINED 
RESULT_CODE_FREAD_OUTPUT_INCOMPLETE 
RESULT_CODE_FWRITE_OUTPUT_INCOMPLETE 

Definition at line 100 of file FlexFactory.h.

Constructor & Destructor Documentation

◆ FlexBodyFileIO()

FlexBodyFileIO::FlexBodyFileIO ( )

Definition at line 403 of file FlexFactory.cpp.

Member Function Documentation

◆ AddItemToSave()

void RoR::FlexBodyFileIO::AddItemToSave ( FlexBody *  fb)
inline

Definition at line 118 of file FlexFactory.h.

◆ CloseFile()

void RoR::FlexBodyFileIO::CloseFile ( )
inlineprivate

Definition at line 133 of file FlexFactory.h.

◆ GetList()

std::vector<FlexBody*>& RoR::FlexBodyFileIO::GetList ( )

◆ GetLoadedItem()

FlexBodyCacheData* RoR::FlexBodyFileIO::GetLoadedItem ( unsigned  index)
inline

Definition at line 119 of file FlexFactory.h.

◆ LoadFile()

FlexBodyFileIO::ResultCode FlexBodyFileIO::LoadFile ( )

Definition at line 361 of file FlexFactory.cpp.

◆ OpenFile()

void FlexBodyFileIO::OpenFile ( const char *  fopen_mode)
private

Definition at line 306 of file FlexFactory.cpp.

◆ ReadAndCheckSignature()

void FlexBodyFileIO::ReadAndCheckSignature ( )
private

Definition at line 181 of file FlexFactory.cpp.

◆ ReadFlexbodyColorsBuffer()

void FlexBodyFileIO::ReadFlexbodyColorsBuffer ( FlexBodyCacheData *  flexbody)
private

Definition at line 292 of file FlexFactory.cpp.

◆ ReadFlexbodyHeader()

void FlexBodyFileIO::ReadFlexbodyHeader ( FlexBodyCacheData *  flexbody)
private

Definition at line 229 of file FlexFactory.cpp.

◆ ReadFlexbodyLocatorList()

void FlexBodyFileIO::ReadFlexbodyLocatorList ( FlexBodyCacheData *  flexbody)
private

Definition at line 242 of file FlexFactory.cpp.

◆ ReadFlexbodyNormalsBuffer()

void FlexBodyFileIO::ReadFlexbodyNormalsBuffer ( FlexBodyCacheData *  flexbody)
private

Definition at line 257 of file FlexFactory.cpp.

◆ ReadFlexbodyPositionsBuffer()

void FlexBodyFileIO::ReadFlexbodyPositionsBuffer ( FlexBodyCacheData *  flexbody)
private

Definition at line 273 of file FlexFactory.cpp.

◆ ReadFromFile()

void FlexBodyFileIO::ReadFromFile ( void *  dest,
size_t  length 
)
private

Definition at line 165 of file FlexFactory.cpp.

◆ ReadMetadata()

void FlexBodyFileIO::ReadMetadata ( FlexBodyFileMetadata *  meta)
private

Definition at line 202 of file FlexFactory.cpp.

◆ SaveFile()

FlexBodyFileIO::ResultCode FlexBodyFileIO::SaveFile ( )

Definition at line 322 of file FlexFactory.cpp.

◆ WriteFlexbodyColorsBuffer()

void FlexBodyFileIO::WriteFlexbodyColorsBuffer ( FlexBody *  flexbody)
private

Definition at line 283 of file FlexFactory.cpp.

◆ WriteFlexbodyHeader()

void FlexBodyFileIO::WriteFlexbodyHeader ( FlexBody *  flexbody)
private

Definition at line 209 of file FlexFactory.cpp.

◆ WriteFlexbodyLocatorList()

void FlexBodyFileIO::WriteFlexbodyLocatorList ( FlexBody *  flexbody)
private

Definition at line 236 of file FlexFactory.cpp.

◆ WriteFlexbodyNormalsBuffer()

void FlexBodyFileIO::WriteFlexbodyNormalsBuffer ( FlexBody *  flexbody)
private

Definition at line 251 of file FlexFactory.cpp.

◆ WriteFlexbodyPositionsBuffer()

void FlexBodyFileIO::WriteFlexbodyPositionsBuffer ( FlexBody *  flexbody)
private

Definition at line 267 of file FlexFactory.cpp.

◆ WriteMetadata()

void FlexBodyFileIO::WriteMetadata ( )
private

Definition at line 192 of file FlexFactory.cpp.

◆ WriteSignature()

void FlexBodyFileIO::WriteSignature ( )
private

Definition at line 175 of file FlexFactory.cpp.

◆ WriteToFile()

void FlexBodyFileIO::WriteToFile ( void *  source,
size_t  length 
)
private

Definition at line 155 of file FlexFactory.cpp.

Field Documentation

◆ FILE_FORMAT_VERSION

const unsigned int RoR::FlexBodyFileIO::FILE_FORMAT_VERSION = 1
static

Definition at line 113 of file FlexFactory.h.

◆ m_cache_entry_number

int RoR::FlexBodyFileIO::m_cache_entry_number
private

Definition at line 160 of file FlexFactory.h.

◆ m_file

FILE* RoR::FlexBodyFileIO::m_file
private

Definition at line 158 of file FlexFactory.h.

◆ m_fileformat_version

unsigned int RoR::FlexBodyFileIO::m_fileformat_version
private

Definition at line 159 of file FlexFactory.h.

◆ m_items_to_save

std::vector<FlexBody*> RoR::FlexBodyFileIO::m_items_to_save
private

Definition at line 156 of file FlexFactory.h.

◆ m_loaded_items

std::vector<FlexBodyCacheData> RoR::FlexBodyFileIO::m_loaded_items
private

Definition at line 157 of file FlexFactory.h.

◆ SIGNATURE

const char * FlexBodyFileIO::SIGNATURE = "RoR FlexBody"
static

Definition at line 112 of file FlexFactory.h.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.17