SimplygonSDK::IReductionPipeline Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IReductionPipeline:

Public Member Functions
virtual CountedPointer< IBoneSettings >	GetBoneSettings ()=0
virtual const char *	GetClass ()
virtual CountedPointer< IMappingImage >	GetMappingImage ()=0
virtual CountedPointer< IMappingImageSettings >	GetMappingImageSettings ()=0
virtual CountedPointer< INormalCalculationSettings >	GetNormalCalculationSettings ()=0
virtual CountedPointer< IReductionSettings >	GetReductionSettings ()=0
virtual CountedPointer< IRepairSettings >	GetRepairSettings ()=0
virtual CountedPointer< IVisibilitySettings >	GetVisibilitySettings ()=0
virtual bool	IsA (const char *type) const
Public Member Functions inherited from SimplygonSDK::IPipeline
virtual void	AddMaterialCaster (IMaterialCaster *MaterialCaster, unsigned int MaterialIndex)=0
virtual CountedPointer< IMaterialCaster >	AddMaterialCasterByType (const char *CasterType, unsigned int MaterialIndex)=0
virtual bool	GetBoolParameter (const char *name)=0
virtual double	GetDoubleParameter (const char *name)=0
virtual int	GetIntParameter (const char *name)=0
virtual CountedPointer< IObjectCollection >	GetMaterialCasters ()=0
virtual unsigned int	GetParameterType (const char *name)=0
virtual CountedPointer< IPipelineSettings >	GetPipelineSettings ()=0
virtual rstring	GetStringParameter (const char *name)=0
virtual unsigned int	GetUIntParameter (const char *name)=0
virtual void	RunScene (IScene *scene)=0
virtual void	RunSceneFromFile (const char *input_scene, const char *output_scene)=0
virtual bool	SetBoolParameter (const char *name, bool value)=0
virtual bool	SetDoubleParameter (const char *name, double value)=0
virtual bool	SetIntParameter (const char *name, int value)=0
virtual bool	SetParameterFromString (const char *name, const char *value)=0
virtual bool	SetStringParameter (const char *name, const char *value)=0
virtual bool	SetUIntParameter (const char *name, unsigned int value)=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 IReductionPipeline *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IPipeline
static bool	IsClassA (const char *type)
static IPipeline *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

IReductionPipeline provides a pipeline for a single reduction processor to be applied on the input scene.

Definition at line 21780 of file SimplygonSDK.h.

Member Function Documentation

GetBoneSettings()

virtual CountedPointer<IBoneSettings> SimplygonSDK::IReductionPipeline::GetBoneSettings ( )

pure virtual

Get the bone settings object containing the bone settings for this pipeline

Returns

the bone settings

GetClass()

virtual const char* SimplygonSDK::IReductionPipeline::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::IPipeline.

GetMappingImage()

virtual CountedPointer<IMappingImage> SimplygonSDK::IReductionPipeline::GetMappingImage ( )

pure virtual

Get the mapping image from the performed reduction. Should only be called after the pipeline has been run

Returns

the mapping image for the reduction

GetMappingImageSettings()

virtual CountedPointer<IMappingImageSettings> SimplygonSDK::IReductionPipeline::GetMappingImageSettings ( )

pure virtual

Get the mapping image settings object containing the mapping image settings for this pipeline

Returns

the mapping image settings

GetNormalCalculationSettings()

virtual CountedPointer<INormalCalculationSettings> SimplygonSDK::IReductionPipeline::GetNormalCalculationSettings ( )

pure virtual

Get the normal calculation settings object containing the normal calculation settings for this pipeline

Returns

the normal calculation settings

GetReductionSettings()

virtual CountedPointer<IReductionSettings> SimplygonSDK::IReductionPipeline::GetReductionSettings ( )

pure virtual

Get the reduction settings object containing the reduction settings for this pipeline

Returns

the reduction settings

GetRepairSettings()

virtual CountedPointer<IRepairSettings> SimplygonSDK::IReductionPipeline::GetRepairSettings ( )

pure virtual

Get the repair settings object containing the repair settings for this pipeline

Returns

the repair settings

GetVisibilitySettings()

virtual CountedPointer<IVisibilitySettings> SimplygonSDK::IReductionPipeline::GetVisibilitySettings ( )

pure virtual

Get the visibility settings object containing the visibility settings for this pipeline

Returns

the visibility settings

IsA()

virtual bool SimplygonSDK::IReductionPipeline::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::IPipeline.

IsClassA()

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

inlinestatic

The IsClassA function returns true if IReductionPipeline 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 21801 of file SimplygonSDK.h.

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IReductionPipeline pointer

Returns

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

Definition at line 21814 of file SimplygonSDK.h.

---

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

• SimplygonSDK.h