volcart::Render Class Reference

Render data. More...

#include <vc/core/types/Render.hpp>

Inheritance diagram for volcart::Render:

Collaboration diagram for volcart::Render:

Public Types
using	Pointer = std::shared_ptr< Render >
Public Types inherited from volcart::DiskBasedObjectBaseClass
using	Identifier = std::string
	Identifier type. More...
using	Description = std::pair< Identifier, std::string >

Public Member Functions
	Render (filesystem::path path)
	Load a Render from file.
	Render (filesystem::path path, Identifier uuid, std::string name)
	Make a new Render in a directory.
auto	graph () const -> std::shared_ptr< smgl::Graph >
	Get the stored render graph. More...
Public Member Functions inherited from volcart::DiskBasedObjectBaseClass
	DiskBasedObjectBaseClass ()=delete
Identifier	id () const
	Get the "unique" ID for the object.
auto	path () const -> filesystem::path
	Get the path to the object.
auto	name () const -> std::string
	Get the human-readable name for the object.
void	setName (std::string n)
	Set the human-readable name of the object.
template<typename T >
void	setMetadataEntry (const std::string &key, T value)
	Set a metadata entry. More...
template<typename T >
auto	getMetadataEntry (const std::string &key) const -> std::optional< T >
	Get a metadata entry. More...
void	saveMetadata () const
	Update metadata on disk.

Static Public Member Functions
static auto	New (filesystem::path path) -> Pointer
static auto	New (filesystem::path path, Identifier uuid, std::string name) -> Pointer

Private Attributes
std::shared_ptr< smgl::Graph >	graph_

Additional Inherited Members
Protected Member Functions inherited from volcart::DiskBasedObjectBaseClass
	DiskBasedObjectBaseClass (filesystem::path path)
	DiskBasedObjectBaseClass (filesystem::path path, Identifier uuid, std::string name)
Protected Attributes inherited from volcart::DiskBasedObjectBaseClass
Metadata	metadata_
filesystem::path	path_

Detailed Description

Render data.

Author

Seth Parker

Provides access to Render information stored on disk, usually inside of a VolumePkg.

Definition at line 26 of file Render.hpp.

Member Typedef Documentation

Pointer

using volcart::Render::Pointer = std::shared_ptr<Render>

Shared pointer type

Definition at line 30 of file Render.hpp.

Member Function Documentation

graph()

auto volcart::Render::graph

(

)

const -> std::shared_ptr< smgl::Graph >

Get the stored render graph.

If not already loaded, this function loads and returns the computational graph for this render. All nodes used in the graph should be registered with the smgl serialization system before calling this function. Nodes provided by Volume Cartographer can be registered with RegisterNodes().

Exceptions

smgl::unknown_identifier

If an unregistered node is encountered

New() [1/2]

static auto volcart::Render::New ( filesystem::path  path ) -> Pointer

static

New() [2/2]

static auto volcart::Render::New ( filesystem::path  path, Identifier  uuid, std::string  name  ) -> Pointer

static

Member Data Documentation

graph_

std::shared_ptr<smgl::Graph> volcart::Render::graph_

mutableprivate

Render graph

Definition at line 60 of file Render.hpp.

---

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

• vc/core/types/Render.hpp