VRay::ScenePreview Class Reference

Classes
class	Object
struct	Particle
struct	Settings
struct	Sizes2D
struct	Sizes3D

Public Types
enum	DataType {   DataTypeAll = -1 , DataTypeNoData = 0 , DataTypeMesh = (1 << 0) , DataTypeHair = (1 << 1) ,   DataTypeParticles = (1 << 2) , DataTypeVolume = (1 << 3) , DataTypeInfinitePlane = (1 << 4) , DataTypeInstancer2 = (1 << 5) ,   DataTypeVRayProxy = (1 << 6) , DataTypeRayserverInstancer = (1 << 7) , DataTypeStaticMesh = (1 << 8) , DataTypePerfectSphere = (1 << 9) ,   DataTypeGeomInstancer = (1 << 10) , DataTypeHasInstances = DataTypeInstancer2 | DataTypeRayserverInstancer | DataTypeGeomInstancer , ObjectDataTypeAll = DataTypeAll , ObjectDataTypeNoData = DataTypeNoData ,   ObjectDataTypeMesh = DataTypeMesh , ObjectDataTypeHair = DataTypeHair , ObjectDataTypeParticles = DataTypeParticles , ObjectDataTypeVolume = DataTypeVolume ,   ObjectDataTypeInfinitePlane = DataTypeInfinitePlane , ObjectDataTypeInstancer2 = DataTypeInstancer2 , ObjectDataTypeVRayProxy = DataTypeVRayProxy , ObjectDataTypeRayserverInstancer = DataTypeRayserverInstancer ,   ObjectDataTypeStaticMesh = DataTypeStaticMesh , ObjectDataTypePerfectSphere = DataTypePerfectSphere , ObjectDataTypeGeomInstancer = DataTypeGeomInstancer , ObjectDataTypeHasInstances = DataTypeHasInstances }
enum	LightType {   LightTypeUnsupported = 0 , LightTypeOmni , LightTypeRectangle , LightTypeSphere ,   LightTypeDirect , LightTypeSpot , LightTypeSun , LightTypeIES ,   LightTypeDome , LightTypeMesh }
enum	ObjectType {   ObjectTypeAll = 0 , ObjectTypeNode , ObjectTypeNodeParticle , ObjectTypeLight ,   ObjectTypeInstancer , ObjectTypeVolume , ObjectTypeVRayScene , ObjectTypeMaterial ,   ObjectTypeDecal , ObjectTypeClipper }
enum	UpAxis { UpAxisUnknown = -1 , UpAxisZ = 0 , UpAxisY }

Public Member Functions
	ScenePreview (const char *filename)
	ScenePreview (const char *filename, const Settings &settings)
int	getFPS () const
	Returns FPS.
int	getFrameEnd () const
	Returns animation end frame.
float	getFramesScale () const
	Returns scene frames scale.
int	getFrameStart () const
	Returns animation start frame.
float	getMetersScale () const
	Returns scene meters scale.
Object	getObject (const char *name) const
std::vector< Object >	getObjects (ObjectType objectType=ObjectTypeAll, DataType dataType=DataTypeAll) const
float	getPhotometricScale () const
	Returns scene photometric scale.
float	getSecondsScale () const
	Returns scene seconds scale.
size_t	getTotalFaces () const
	Returns the total number of faces.
UpAxis	getUpAxis () const
	Returns scene up axis.
	operator bool () const
bool	operator! () const

Constructor & Destructor Documentation

ScenePreview() [1/2]

VRay::ScenePreview::ScenePreview ( const char *  filename )

explicit

Constructs a ScenePreview container from the given scene file. If exceptions are not disabled, throws FileReadErr().

Parameters

filename

The file to extract preview info from.

ScenePreview() [2/2]

VRay::ScenePreview::ScenePreview	(	const char *	filename,
		const Settings &	settings
	)

Constructs a ScenePreview container from the given scene file. If exceptions are not disabled, throws FileReadErr().

Parameters

filename	The file to extract preview info from.
settings	Additional params. See ScenePreview::Settings struct.

Member Function Documentation

getObject()

Object VRay::ScenePreview::getObject

(

const char *

name

)

const

Returns a scene object by name.

Parameters

name	An object name (a plugin name in the vrscene-file).

Returns

The scene object. May be invalid/empty.

getObjects()

std::vector< Object > VRay::ScenePreview::getObjects	(	ObjectType	objectType = ObjectTypeAll,
		DataType	dataType = DataTypeAll
	)		const

Returns all or some of the objects contained in the scene file.

Parameters

objectType	Specifies what type of object to return. Default is all types.
dataType	Specifies what data the returned objects have to contain. More than one type can be specified e.g. DataType(DataTypeHair | DataTypeParticles). Default is all data types.

Returns

A vector containing the scene objects.

operator bool()

VRay::ScenePreview::operator bool ( ) const

inline

If exceptions are disabled check if the container holds valid data.

Returns

true if the container holds valid data.

operator!()

bool VRay::ScenePreview::operator! ( ) const

inline

If exceptions are disabled check if the container holds valid data.

Returns

true if the container doesn't hold valid data.

---

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

• /home/jenkins/ci/cgrepo/appsdk/VRay_SDK_CPP/include/vraysdk.hpp