VRay.ScenePreview Class Reference

Classes
class	Object
class	Particle
class	Settings
struct	Size2D
struct	Size3D

Public Types
enum	DataType
enum	LightType
enum	ObjectType
enum	UpAxis

Public Member Functions
	ScenePreview (string filename, Settings settings=null)
	Constructs a ScenePreview container from the given scene file. More...
void	Dispose ()
	Releases internal resources held by the ScenePreview object.
int	GetFPS ()
	Returns FPS.
int	GetFrameEnd ()
	Returns animation end frame.
float	GetFramesScale ()
	Returns scene frames scale.
int	GetFrameStart ()
	Returns animation start frame.
float	GetMetersScale ()
	Returns scene meters scale.
Object	GetObject (string name)
	Returns a scene object by name. More...
IEnumerable< Object >	GetObjects (ObjectType objectType=ObjectType.All, DataType dataType=DataType.All)
	Returns all or some of the objects contained in the scene file. More...
float	GetPhotometricScale ()
	Returns scene photometric scale.
float	GetSecondsScale ()
	Returns scene seconds scale.
long	GetTotalFaces ()
	Returns the total number of faces.
UpAxis	GetUpAxis ()
	Returns scene up axis.

Constructor & Destructor Documentation

ScenePreview()

VRay.ScenePreview.ScenePreview	(	string	filename,
		Settings	settings = null
	)

Constructs a ScenePreview container from the given scene file.

Parameters

filename	The file to extract preview info from.
settings	Optional additional settings.

Member Function Documentation

GetObject()

Object VRay.ScenePreview.GetObject

(

string

name

)

Returns a scene object by name.

Parameters

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

Returns

The scene object or null if missing.

GetObjects()

IEnumerable< Object > VRay.ScenePreview.GetObjects	(	ObjectType	objectType = ObjectType.All,
		DataType	dataType = DataType.All
	)

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. (DataTypeHair | DataTypeParticles).

Returns

The scene objects.

---

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

• /home/jenkins/ci/cgrepo/appsdk/VRay_SDK_CSharp/VRay_SDK_CSharp/VRayRT/ScenePreview.cs