C++ class Rendering::Serialization::AbstractRenderingStreamer
AbstractRenderingStreamer

public

Inheritance Graph

graph BT
	AbstractRenderingStreamer
	AbstractRenderingStreamer --> AbstractStreamer
	StreamerMD2 --> AbstractRenderingStreamer
	StreamerMMF --> AbstractRenderingStreamer
	StreamerMTL --> AbstractRenderingStreamer
	StreamerMVBO --> AbstractRenderingStreamer
	StreamerNGC --> AbstractRenderingStreamer
	StreamerOBJ --> AbstractRenderingStreamer
	StreamerPKM --> AbstractRenderingStreamer
	StreamerPLY --> AbstractRenderingStreamer
	StreamerXYZ --> AbstractRenderingStreamer
	click AbstractRenderingStreamer "classRendering_1_1Serialization_1_1AbstractRenderingStreamer"
	click AbstractStreamer "classUtil_1_1Serialization_1_1AbstractStreamer"
	click StreamerMD2 "classRendering_1_1Serialization_1_1StreamerMD2"
	click StreamerMMF "classRendering_1_1Serialization_1_1StreamerMMF"
	click StreamerMTL "classRendering_1_1Serialization_1_1StreamerMTL"
	click StreamerMVBO "classRendering_1_1Serialization_1_1StreamerMVBO"
	click StreamerNGC "classRendering_1_1Serialization_1_1StreamerNGC"
	click StreamerOBJ "classRendering_1_1Serialization_1_1StreamerOBJ"
	click StreamerPKM "classRendering_1_1Serialization_1_1StreamerPKM"
	click StreamerPLY "classRendering_1_1Serialization_1_1StreamerPLY"
	click StreamerXYZ "classRendering_1_1Serialization_1_1StreamerXYZ"

Description

Interface for classes that are capable of converting between meshes and streams, or textures and streams. Subclasses are allowed to implement only a subset of the functions.

Author: Benjamin Eikel

Date: 2011-09-08

Public Static Attributes

const uint8_t	CAP_LOAD_MESH Streamer supports the functionloadMesh.
const uint8_t	CAP_SAVE_MESH Streamer supports the functionsaveMesh.
const uint8_t	CAP_LOAD_TEXTURE Streamer supports the functionloadTexture.
const uint8_t	CAP_SAVE_TEXTURE Streamer supports the functionsaveTexture.

Public Functions

	~AbstractRenderingStreamer()
Mesh *	loadMesh(std::istream & void)
bool	saveMesh( Mesh * void, std::ostream & void)
Util::Reference < Texture >	loadTexture(std::istream & void, TextureType void, uint32_t void)
bool	saveTexture( Texture * void, std::ostream & void)

Public Static Functions

uint8_t	queryCapabilities(const std::string & void)

Protected Functions

	AbstractRenderingStreamer() Creation is only possible in subclasses.

---

Documentation

variable
Rendering::Serialization::AbstractRenderingStreamer::CAP_LOAD_MESH

public

static

const uint8_t CAP_LOAD_MESH

Streamer supports the functionloadMesh.

_{Defined in Rendering/Serialization/AbstractRenderingStreamer.h:84}

---

variable
Rendering::Serialization::AbstractRenderingStreamer::CAP_SAVE_MESH

public

static

const uint8_t CAP_SAVE_MESH

Streamer supports the functionsaveMesh.

_{Defined in Rendering/Serialization/AbstractRenderingStreamer.h:85}

---

variable
Rendering::Serialization::AbstractRenderingStreamer::CAP_LOAD_TEXTURE

public

static

const uint8_t CAP_LOAD_TEXTURE

Streamer supports the functionloadTexture.

_{Defined in Rendering/Serialization/AbstractRenderingStreamer.h:86}

---

variable
Rendering::Serialization::AbstractRenderingStreamer::CAP_SAVE_TEXTURE

public

static

const uint8_t CAP_SAVE_TEXTURE

Streamer supports the functionsaveTexture.

_{Defined in Rendering/Serialization/AbstractRenderingStreamer.h:87}

---

function
Rendering::Serialization::AbstractRenderingStreamer::~AbstractRenderingStreamer

public

inline

virtual

~AbstractRenderingStreamer(	)

_{Defined in Rendering/Serialization/AbstractRenderingStreamer.h:35}

---

function
Rendering::Serialization::AbstractRenderingStreamer::loadMesh

public

inline

virtual

Mesh * loadMesh(	std::istream &	void )

Load a mesh from the given stream.

Parameters

input

Use the data from the stream beginning at the preset position.

Returns

Mesh object. The caller is responsible for the memory deallocation.

_{Defined in Rendering/Serialization/AbstractRenderingStreamer.h:44}

---

function
Rendering::Serialization::AbstractRenderingStreamer::saveMesh

public

inline

virtual

bool saveMesh(	Mesh *	void,
	std::ostream &	void
)

Save a mesh to the given stream.

Parameters

mesh

Mesh object to save.

output

Use the stream for writing beginning at the preset position.

Returns

trueif successful,falseotherwise.

_{Defined in Rendering/Serialization/AbstractRenderingStreamer.h:56}

---

function
Rendering::Serialization::AbstractRenderingStreamer::loadTexture

public

inline

virtual

Util::Reference < Texture > loadTexture(	std::istream &	void,
	TextureType	void,
	uint32_t	void
)

Load a texture from the given stream.

Parameters

input

Use the data from the stream beginning at the preset position.

Returns

Texture object. The caller is responsible for the memory deallocation.

_{Defined in Rendering/Serialization/AbstractRenderingStreamer.h:67}

---

function
Rendering::Serialization::AbstractRenderingStreamer::saveTexture

public

inline

virtual

bool saveTexture(	Texture *	void,
	std::ostream &	void
)

Save a texture to the given stream.

Parameters

texture

Texture object to save.

output

Use the stream for writing beginning at the preset position.

Returns

trueif successful,falseotherwise.

_{Defined in Rendering/Serialization/AbstractRenderingStreamer.h:79}

---

function
Rendering::Serialization::AbstractRenderingStreamer::queryCapabilities

public

static

inline

uint8_t queryCapabilities(	const std::string &	void )

Check which capabilities are supported for the given file extension.

Parameters

extension

File extension in lower case to check capabilities for.

Returns

Bitmask consisting of a combination ofCAP_LOAD_GENERICandCAP_SAVE_GENERIC,CAP_LOAD_MESH,CAP_SAVE_MESH,CAP_LOAD_TEXTURE,CAP_SAVE_TEXTURE, or zero.

_{Defined in Rendering/Serialization/AbstractRenderingStreamer.h:95}

---

function
Rendering::Serialization::AbstractRenderingStreamer::AbstractRenderingStreamer

protected

inline

AbstractRenderingStreamer(	)

Creation is only possible in subclasses.

_{Defined in Rendering/Serialization/AbstractRenderingStreamer.h:101}

---