Simplygon C++ API  8.3.35800.0
Public Member Functions | Static Public Member Functions | List of all members
SimplygonSDK::IAggregationPipeline Class Referenceabstract

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IAggregationPipeline:
SimplygonSDK::IPipeline SimplygonSDK::IObject

Public Member Functions

virtual CountedPointer< IAggregationSettings > GetAggregationSettings ()=0
 
virtual const char * GetClass ()
 
virtual CountedPointer< IMappingImage > GetMappingImage ()=0
 
virtual CountedPointer< IMappingImageSettings > GetMappingImageSettings ()=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 IAggregationPipeline * 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

IAggregationPipeline provides a pipeline for a single aggregation processor to be applied on the input scene.

Definition at line 21982 of file SimplygonSDK.h.

Member Function Documentation

◆ GetAggregationSettings()

virtual CountedPointer<IAggregationSettings> SimplygonSDK::IAggregationPipeline::GetAggregationSettings ( )
pure virtual

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

Returns
the reduction settings

◆ GetClass()

virtual const char* SimplygonSDK::IAggregationPipeline::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::IAggregationPipeline::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::IAggregationPipeline::GetMappingImageSettings ( )
pure virtual

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

Returns
the mapping image settings

◆ GetVisibilitySettings()

virtual CountedPointer<IVisibilitySettings> SimplygonSDK::IAggregationPipeline::GetVisibilitySettings ( )
pure virtual

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

Returns
the visibility settings

◆ IsA()

virtual bool SimplygonSDK::IAggregationPipeline::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
typeis 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::IAggregationPipeline::IsClassA ( const char *  type)
inlinestatic

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

Parameters
typeis 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 22003 of file SimplygonSDK.h.

◆ SafeCast()

static IAggregationPipeline* SimplygonSDK::IAggregationPipeline::SafeCast ( IObject *  ptr)
inlinestatic

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

Parameters
ptris the pointer to be cast into a IAggregationPipeline pointer
Returns
a pointer to the IAggregationPipeline object, if the cast can be made, and a NULL pointer otherwise

Definition at line 22016 of file SimplygonSDK.h.

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