SimplygonSDK::IMappingImage Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IMappingImage:

Public Member Functions
virtual const char *	GetClass ()
virtual unsigned int	GetHeight ()=0
virtual CountedPointer< IChunkedImageData >	GetImageData ()=0
virtual unsigned int	GetLayerCount ()=0
virtual CountedPointer< IMappingImageMeshData >	GetMappingMeshData ()=0
virtual unsigned int	GetMultisamplingHeight ()=0
virtual unsigned int	GetMultisamplingWidth ()=0
virtual unsigned int	GetWidth ()=0
virtual bool	IsA (const char *type) const
virtual CountedPointer< IMappingImage >	NewQuartersizeCopy ()=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 IMappingImage *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

IMappingImage stores the mapping between a processed geometry and the source geometry it is based on. The mapping image object also stores multisampling settings. It can be used to cast information from the original geometry to the processed geometry, such as surface transfer or calculating normal maps. See IMaterialCaster and subclasses for casting uses.

Definition at line 7630 of file SimplygonSDK.h.

Member Function Documentation

GetClass()

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

GetHeight()

virtual unsigned int SimplygonSDK::IMappingImage::GetHeight ( )

pure virtual

Get the height of the mapping texture.

Returns

the Height of the mapping texture

GetImageData()

virtual CountedPointer<IChunkedImageData> SimplygonSDK::IMappingImage::GetImageData ( )

pure virtual

Get the ImageData object, which stores the mapping data

Returns

the ImageData object

GetLayerCount()

virtual unsigned int SimplygonSDK::IMappingImage::GetLayerCount ( )

pure virtual

Get the number of layers of the mapping texture.

Returns

the LayerCount of the mapping texture

GetMappingMeshData()

virtual CountedPointer<IMappingImageMeshData> SimplygonSDK::IMappingImage::GetMappingMeshData ( )

pure virtual

Get the IMappingImageMeshData Mesh data that is used to retrieve the triangle mapping to mesh information to map back to the original scene.

Returns

the mapping mesh data object

GetMultisamplingHeight()

virtual unsigned int SimplygonSDK::IMappingImage::GetMultisamplingHeight ( )

pure virtual

Get the multi sampling height of the mapping texture.

Returns

the multi sampling height

GetMultisamplingWidth()

virtual unsigned int SimplygonSDK::IMappingImage::GetMultisamplingWidth ( )

pure virtual

Get the multi sampling width of the mapping texture.

Returns

the multi sampling width

GetWidth()

virtual unsigned int SimplygonSDK::IMappingImage::GetWidth ( )

pure virtual

Get the width of the mapping texture.

Returns

the Width of the mapping texture

IsA()

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

inlinestatic

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

NewQuartersizeCopy()

virtual CountedPointer<IMappingImage> SimplygonSDK::IMappingImage::NewQuartersizeCopy ( )

pure virtual

Return a copy of the mapping image which is scaled in size by half, in width and height. The area covered is a quarter size of the original, hence it's name.

Returns

copy of the mapping image, reduced in size to half of the original width and height

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IMappingImage pointer

Returns

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

Definition at line 7664 of file SimplygonSDK.h.

---

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

• SimplygonSDK.h