prtx::EncodePreparator::FinalizedInstance Class Reference

#include <EncodePreparator.h>

Inheritance diagram for prtx::EncodePreparator::FinalizedInstance:

Public Member Functions
bool	allMeshFacesConvex (size_t meshIndex) const
bool	allMeshFacesPlanar (size_t meshIndex) const
const GeometryPtr &	getGeometry () const
uint32_t	getInitialShapeIndex () const
const std::wstring &	getInitialShapeName () const
const prtx::MaterialPtrVector &	getMaterials () const
int32_t	getPrototypeIndex () const
const ReportsPtr &	getReports () const
uint32_t	getShapeId () const
const std::wstring &	getShapeName () const
const prtx::DoubleVector &	getTransformation () const

Static Public Attributes
static const uint32_t	NO_INITIAL_SHAPE_INDEX = uint32_t(-1)
static const int32_t	NO_PROTOTYPE_INDEX = -1
static const uint32_t	NO_SHAPE_ID = uint32_t(-1)

Friends
class	EncodePreparator

Detailed Description

Container class for a finalized (= prepared) geometry instance.

Member Function Documentation

allMeshFacesConvex()

bool prtx::EncodePreparator::FinalizedInstance::allMeshFacesConvex

(

size_t

meshIndex

)

const

Returns true if all faces of mesh at index meshIndex are convex. Note: will always return false unless PreparatorFlags::determineMeshProperties() has been set to true.

See also

prtx::Geometry::getMeshes()

allMeshFacesPlanar()

bool prtx::EncodePreparator::FinalizedInstance::allMeshFacesPlanar

(

size_t

meshIndex

)

const

Returns true if all faces of mesh at index meshIndex are planar. Note: will always return false unless PreparatorFlags::determineMeshProperties() has been set to true.

See also

prtx::Geometry::getMeshes()

getGeometry()

const GeometryPtr& prtx::EncodePreparator::FinalizedInstance::getGeometry

(

)

const

Returns the prepared geometry with associated meshes, materials and textures. Note that the geometry is potentially shared across multiple instances.

getInitialShapeIndex()

uint32_t prtx::EncodePreparator::FinalizedInstance::getInitialShapeIndex

(

)

const

Returns the initial shape index.

getInitialShapeName()

const std::wstring& prtx::EncodePreparator::FinalizedInstance::getInitialShapeName

(

)

const

Returns the finalized initial shape name.

See also

prt::InitialShape

getMaterials()

const prtx::MaterialPtrVector& prtx::EncodePreparator::FinalizedInstance::getMaterials

(

)

const

Returns the finalized materials corresponding to the meshes in the geometry returned by getGeometry(). Note that in the case of enabled instancing, these are the final materials as specified in the rules, whereas the materials attached to the meshes are the original asset materials.

The size and order of the returned vector corresponds to the concatenation of all materials returned by prtx::Mesh::getMaterials().

See also

PreparationFlags::instancing

prtx::Mesh::getMaterials

getPrototypeIndex()

int32_t prtx::EncodePreparator::FinalizedInstance::getPrototypeIndex

(

)

const

Returns the prototype index. All instances which share the same cached geometry (= backed by an URI) have the same index. Returns NO_PROTOTYPE_INDEX if the geometry is not cached.

See also

prt::Cache

getReports()

const ReportsPtr& prtx::EncodePreparator::FinalizedInstance::getReports

(

)

const

Returns the reports of the shape this instance has originated from.

getShapeId()

uint32_t prtx::EncodePreparator::FinalizedInstance::getShapeId

(

)

const

Returns the id of the shape this geometry comes from.

getShapeName()

const std::wstring& prtx::EncodePreparator::FinalizedInstance::getShapeName

(

)

const

Returns the finalized name of the shape this geometry comes from.

getTransformation()

const prtx::DoubleVector& prtx::EncodePreparator::FinalizedInstance::getTransformation

(

)

const

Returns the to world transformation of this instance in column-major format.

---

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

• EncodePreparator.h