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

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IFoliageProcessor:
SimplygonSDK::IProcessingObject SimplygonSDK::IObject

Public Member Functions

virtual const char * GetClass ()
 
virtual SGDEPRECATED CountedPointer< IMappingImage > GetFoliageMappingImage ()=0
 
virtual int GetFoliageMaterialID ()=0
 
virtual CountedPointer< IFoliageSettings > GetFoliageSettings ()=0
 
virtual CountedPointer< IMappingImage > GetMappingImage ()=0
 
virtual CountedPointer< IMappingImageSettings > GetMappingImageSettings ()=0
 
virtual CountedPointer< IScene > GetScene ()=0
 
virtual bool IsA (const char *type) const
 
virtual void SetScene (IScene *value)=0
 
- Public Member Functions inherited from SimplygonSDK::IProcessingObject
virtual void Clear ()=0
 
virtual real GetPercentDone ()=0
 
virtual void RunProcessing ()=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 IFoliageProcessor * SafeCast (IObject *ptr)
 
- Static Public Member Functions inherited from SimplygonSDK::IProcessingObject
static bool IsClassA (const char *type)
 
static IProcessingObject * SafeCast (IObject *ptr)
 
- Static Public Member Functions inherited from SimplygonSDK::IObject
static bool IsClassA (const char *type)
 
static IObject * SafeCast (IObject *ptr)
 

Detailed Description

Definition at line 20009 of file SimplygonSDK.h.

Member Function Documentation

◆ GetClass()

virtual const char* SimplygonSDK::IFoliageProcessor::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::IProcessingObject.

◆ GetFoliageMappingImage()

virtual SGDEPRECATED CountedPointer<IMappingImage> SimplygonSDK::IFoliageProcessor::GetFoliageMappingImage ( )
pure virtual
Deprecated:
Method is marked as deprecated and will be removed in future version. Use GetMappingImage() instead. The MappingImage for the Impostor geometry.
Returns
the MappingImage object associated with the processor

◆ GetFoliageMaterialID()

virtual int SimplygonSDK::IFoliageProcessor::GetFoliageMaterialID ( )
pure virtual

The

Returns
the

◆ GetFoliageSettings()

virtual CountedPointer<IFoliageSettings> SimplygonSDK::IFoliageProcessor::GetFoliageSettings ( )
pure virtual

The settings for the ImpostorProcessor.

Returns
the ImpostorProcessor settings object associated with the processor

◆ GetMappingImage()

virtual CountedPointer<IMappingImage> SimplygonSDK::IFoliageProcessor::GetMappingImage ( )
pure virtual

The MappingImage for the Impostor geometry.

Returns
the MappingImage object associated with the processor

◆ GetMappingImageSettings()

virtual CountedPointer<IMappingImageSettings> SimplygonSDK::IFoliageProcessor::GetMappingImageSettings ( )
pure virtual

The settings for the the MappingImage.

Returns
the MappingImage settings object associated with the processor

◆ GetScene()

virtual CountedPointer<IScene> SimplygonSDK::IFoliageProcessor::GetScene ( )
pure virtual

Get the scene for the imposter processing. Please note that internal refrences might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

Returns
the current scene

◆ IsA()

virtual bool SimplygonSDK::IFoliageProcessor::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::IProcessingObject.

◆ IsClassA()

static bool SimplygonSDK::IFoliageProcessor::IsClassA ( const char *  type)
inlinestatic

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

◆ SafeCast()

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

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

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

Definition at line 20043 of file SimplygonSDK.h.

◆ SetScene()

virtual void SimplygonSDK::IFoliageProcessor::SetScene ( IScene *  value)
pure virtual

Set the scene for the impostor processing. Please note that internal refrences might be modified by the processor. The caller should refresh any reference that is cached outside the scene after running the processor.

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