# rvmparser

**Repository Path**: ticpas/rvmparser

## Basic Information

- **Project Name**: rvmparser
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-07-14
- **Last Updated**: 2021-11-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# rvmparser

Code to work with AVEVA PDMS RVM files. Written completely from scratch, intended to be very fast, small, and with _little dependencies_, so it is trivial to include in existing projects.

Includes a sample application that:
- Reads AVEVA PDMS binary RVM and attribute files.
- Tries to match adjacent geometries to:
  - Avoid adding internal caps between adjacent shapes.
  - Align circumferential sample points between adjacent shapes.
- Triangulate primitive shapes with a prescribed error tolerance.
- Optionally merges groups using a prescribed list of groups.
- Exports geometry as Wavefront OBJ files
- Exports geometry as GLTF files
- Exports attributes as json.

## Usage

```
Usage: rvmparser [options] files                

Files with .rvm-suffix will be interpreted as a geometry files, and files with .txt or .att suffix
will be interpreted as attribute files. A rvm file typically has a matching attribute file.

Options:
  --keep-groups=filename.txt          Provide a list of group names to keep. Groups not itself or
                                      with a child in this list will be merged with the first
                                      parent that should be kept.
  --discard-groups=filename.txt       Provide a list of group names to discard, one name per line.
                                      Groups with its name in this list will be discarded along
                                      with its children. Default is no groups are discarded.
  --output-json=<filename.json>       Write hierarchy with attributes to a json file.
  --output-txt=<filename.txt>         Dump all group names to a text file.
  --output-obj=<filenamestem>         Write geometry to an obj file. The suffices .obj and .mtl are
                                      added to the filenamestem.
  --output-gltf=<filename.glb>        Write geometry into a GLTF file.
  --output-gltf-attributes=<bool>     Include rvm attributes in the extra member of nodes. Default
                                      value is true.
  --output-gltf-center=<bool>         Position the model at the bounding box center and store the
                                      position of this origin in the asset's extra field. This is
                                      useful if the model is so far away from the origin that float
                                      precision becomes an issue. Defaults value is false.
  --output-gltf-rotate-z-to-y=<bool>  Add an extra node below the root that adds a clockwise
                                      rotation of 90 degrees about the X axis such that the +Z axis
                                      will map to the +Y axis, which is the up-direction of GLTF-
                                      files. Default value is true.
  --group-bounding-boxes              Include wireframe of boundingboxes of groups in output.
  --color-attribute=key               Specify which attributes that contain color, empty key
                                      implies that material id of group is used.
  --tolerance=value                   Tessellation tolerance, given in world frame. Default value
                                      is 0.1.
  --cull-scale=value                  Cull objects smaller than cull-scale times tolerance. Set to
                                      a negative value to disable culling. Disabled by default.
```

## Building

Clone the git repo, and update submodules
```
git submodule update --init --recursive
```
The submodule dependencies are:
- [libtess2](https://github.com/memononen/libtess2) is used to triangulate polygon more complex than quads.
- [rapidjson](https://github.com/Tencent/rapidjson/) is used to output attributes as JSON.

The project is just a few source-files, so it should be trivial to use with any build systems.

### Visual Studio / Windows

Open the solution file located in `msvc15` and build the project.

It is currently kept as a Visual Studio 2017 solution for compatibility, but this can easily be
updated by opening the solution in a newer visual studio, right-clicking on the solution in the
Solution Explorer, choose "Retarget Projects", and there choose the latest Windows SDK Version and
Platform Toolset that you have installed.

### POSIX

Enter the `make` directory. Type
```
export CXX=clang++
export CC=clang
make
```
Rvmparser doesn't currently build with GCC as the source currently contains use of anonymous aggregates of members with constructors. Use clang instead for now.

## See also
- [Plant Mock-Up Converter](https://github.com/benvautrin/pmuc).

## License

This application is available to anybody free of charge, under the terms of the MIT License (see LICENSE).