SimplygonSDK::IDirectXRenderer Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IDirectXRenderer:

Public Member Functions
virtual bool	CreatePreviewer (int _width, int _height)=0
virtual const char *	GetClass ()
virtual bool	IsA (const char *type) const
virtual bool	LoadGeometryData (IGeometryData *geom, IMaterialTable *materials)=0
virtual bool	LoadGeometryDataWithMaterialShadingNetwork (IScene *_scene)=0
virtual void	RenderAlongCameraPathAndStorePics (int cameraSelectionSetID, const char *file_name_base, const char *format)=0
virtual void	SetRenderWireFrameMode (bool flag)=0
Public Member Functions inherited from SimplygonSDK::IObject
virtual rid	AddObserver (robserver *Observer, rid EventId)=0
virtual void	AddRef ()=0
virtual rstring	GetName ()=0
virtual void *	GetUserComponentArea (rid userid)=0
virtual void	PrintInfo ()=0
virtual void	Release ()=0
virtual void	RemoveObserver (rid ObserverId)=0
virtual void	SetName (const char *Name)=0

Static Public Member Functions
static bool	IsClassA (const char *type)
static IDirectXRenderer *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

A Renderer using DirectX 11 that can be used to preview a scene object containing geometry data by rendering it from selected SceneCamera nodes within the given scene and then storing the frames to disc. If using a Shading Node Network (having an IShadingNode assigned to the IMaterial), then the material can be previewed with the generated HLSL shader.

Definition at line 4535 of file SimplygonSDK.h.

Member Function Documentation

CreatePreviewer()

virtual bool SimplygonSDK::IDirectXRenderer::CreatePreviewer ( int  _width, int  _height  )

pure virtual

Creates a previewer with the specified window dimensions.

Parameters

_width	the window width
_height	the window height

Returns

true if the previewer was successfully created

GetClass()

virtual const char* SimplygonSDK::IDirectXRenderer::GetClass ( )

virtual

GetClass returns the name of the class of the object.

Returns

the name of the actual class of the object, as a const char string

Reimplemented from SimplygonSDK::IObject.

IsA()

virtual bool SimplygonSDK::IDirectXRenderer::IsA ( const char *  type ) const

virtual

The IsA function returns true if the object is a or is a descendant of the class named as the type parameter

Parameters

type	is the name of the class to check if the object is, or is a descendant of

Returns

true if the object is of the specified class, false if not

Reimplemented from SimplygonSDK::IObject.

IsClassA()

static bool SimplygonSDK::IDirectXRenderer::IsClassA ( const char *  type )

inlinestatic

The IsClassA function returns true if IDirectXRenderer is a or is a descendant of the class named as the type parameter

Parameters

type	is the name of the class to check if the class is, or is a descendant of

Returns

true if the class is of the specified class, false if not

Definition at line 4556 of file SimplygonSDK.h.

LoadGeometryData()

virtual bool SimplygonSDK::IDirectXRenderer::LoadGeometryData ( IGeometryData *  geom, IMaterialTable *  materials  )

pure virtual

Loads a geometry data object and its materials into the previewer.

Parameters

geom	the geometry data object to preview
materials	the material table of the geometry. Can be NULL if no material table exists.

Returns

true if the geometry data was successfully loaded

LoadGeometryDataWithMaterialShadingNetwork()

virtual bool SimplygonSDK::IDirectXRenderer::LoadGeometryDataWithMaterialShadingNetwork ( IScene *  _scene )

pure virtual

Loads a scene into the previewer. The material should have a shading network attached to it.

Parameters

_scene

the scene to preview.

Returns

true if the scene was successfully loaded

RenderAlongCameraPathAndStorePics()

virtual void SimplygonSDK::IDirectXRenderer::RenderAlongCameraPathAndStorePics ( int  cameraSelectionSetID, const char *  file_name_base, const char *  format  )

pure virtual

Render from each camera view in the camera target direction specified in the selection set with the scene cameras and stores the frame to the file path specified.

Parameters

cameraSelectionSetID	the ID of the selection set with the scene cameras to render from
file_name_base	the desired directory and file name
format	picture format (PNG or RAW)

SafeCast()

static IDirectXRenderer* SimplygonSDK::IDirectXRenderer::SafeCast ( IObject *  ptr )

inlinestatic

SafeCast makes sure the pointer is of a class that can be cast into a IDirectXRenderer pointer, and if this is possible, returns the cast pointer.

Parameters

ptr	is the pointer to be cast into a IDirectXRenderer pointer

Returns

a pointer to the IDirectXRenderer object, if the cast can be made, and a NULL pointer otherwise

Definition at line 4569 of file SimplygonSDK.h.

SetRenderWireFrameMode()

virtual void SimplygonSDK::IDirectXRenderer::SetRenderWireFrameMode ( bool  flag )

pure virtual

Sets the render mode to wire frame

Parameters

flag	true if render mode should be enabled

---

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

• SimplygonSDK.h