SimplygonSDK::ISurfaceMapper Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::ISurfaceMapper:

Public Member Functions
virtual const char *	GetClass ()
virtual CountedPointer< IGeometryData >	GetDestinationGeometry ()=0
virtual CountedPointer< IScene >	GetDestinationScene ()=0
virtual rid	GetDestinationTexCoordSet ()=0
virtual CountedPointer< IMappingImage >	GetMappingImage ()=0
virtual CountedPointer< IMappingImageSettings >	GetMappingImageSettings ()=0
virtual bool	GetRecalculateSearchDirection ()=0
virtual real	GetSearchDirectionHardEdgeAngleInRadians ()=0
virtual real	GetSearchDistance ()=0
virtual real	GetSearchOffset ()=0
virtual CountedPointer< IGeometryData >	GetSourceGeometry ()=0
virtual CountedPointer< IScene >	GetSourceScene ()=0
virtual bool	IsA (const char *type) const
virtual void	RunSurfaceMapping ()=0
virtual void	SetDestinationGeometry (IGeometryData *value)=0
virtual void	SetDestinationScene (IScene *value)=0
virtual void	SetDestinationTexCoordSet (rid value)=0
virtual void	SetRecalculateSearchDirection (bool value)=0
virtual void	SetSearchDirectionHardEdgeAngleInRadians (real value)=0
virtual void	SetSearchDistance (real value)=0
virtual void	SetSearchOffset (real value)=0
virtual void	SetSourceGeometry (IGeometryData *value)=0
virtual void	SetSourceScene (IScene *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 ISurfaceMapper *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

ISurfaceMapper creates a mapping image between two user-defined geometries. The mapper basically looks for the source geometry in the inverse normal direction from the outwardly offset destination geometry, and maps pixels accordingly. This means that you can modify the normals of the destination geometry to adjust the search direction to your liking. The geometries can either be set as IGeometryDatas or as the root nodes of scenes. If both are set, the scene is used.

Definition at line 19539 of file SimplygonSDK.h.

Member Function Documentation

GetClass()

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

GetDestinationGeometry()

virtual CountedPointer<IGeometryData> SimplygonSDK::ISurfaceMapper::GetDestinationGeometry ( )

pure virtual

Get the destination geometry data

Returns

the current top scene node

GetDestinationScene()

virtual CountedPointer<IScene> SimplygonSDK::ISurfaceMapper::GetDestinationScene ( )

pure virtual

Get the scene used for vertex baking.

Returns

the current top scene node

GetDestinationTexCoordSet()

virtual rid SimplygonSDK::ISurfaceMapper::GetDestinationTexCoordSet ( )

pure virtual

Get the texcoord level in the destination geom to use for the material transfer

Returns

the texcoord level

GetMappingImage()

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

pure virtual

Get the mapping image.

Returns

the mapping image

GetMappingImageSettings()

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

pure virtual

Get the mapping image settings. Currently, the only applicable settings for this mapper is size, gutter, and supersampling settings.

Returns

the mapping image settings object

GetRecalculateSearchDirection()

virtual bool SimplygonSDK::ISurfaceMapper::GetRecalculateSearchDirection ( )

pure virtual

Get the RecalculateSearchDirection flag. If set, the search direction from the destination mesh to the source mesh will be determined by an internal normal calculation with the specified hard edge angle. If false, the search direction will be determined by the existing normals of the destination geometry.

Returns

the RecalculateSearchDirection flag

GetSearchDirectionHardEdgeAngleInRadians()

virtual real SimplygonSDK::ISurfaceMapper::GetSearchDirectionHardEdgeAngleInRadians ( )

pure virtual

Get the hard edge angle. If RecalculateSearchDirection is set, the search direction from the destination mesh to the source mesh will be determined by an internal normal calculation with the specified hard edge angle. If false, the search direction will be determined by the existing normals of the destination geometry.

Returns

the hard edge angle

GetSearchDistance()

virtual real SimplygonSDK::ISurfaceMapper::GetSearchDistance ( )

pure virtual

Get the RecalculateSearchDirection flag. If set, the search direction from the destination mesh to the source mesh will be determined by an internal normal calculation with the specified hard edge angle.

Returns

the search distance

GetSearchOffset()

virtual real SimplygonSDK::ISurfaceMapper::GetSearchOffset ( )

pure virtual

Get the search offset. This is how far out from the destination geometry the search for the source geometry will begin, propagating inwardly for the length of SearchDistance. If negative, it will be set to a sane default internally, based on the mesh size.

Returns

the search offset

GetSourceGeometry()

virtual CountedPointer<IGeometryData> SimplygonSDK::ISurfaceMapper::GetSourceGeometry ( )

pure virtual

Get the source geometry data the surface transfer source

Returns

the current top scene node

GetSourceScene()

virtual CountedPointer<IScene> SimplygonSDK::ISurfaceMapper::GetSourceScene ( )

pure virtual

Get the scene used for the surface transfer source

Returns

the current top scene node

IsA()

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

inlinestatic

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

RunSurfaceMapping()

virtual void SimplygonSDK::ISurfaceMapper::RunSurfaceMapping ( )

pure virtual

Runs the surface mapping

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a ISurfaceMapper pointer

Returns

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

Definition at line 19573 of file SimplygonSDK.h.

SetDestinationGeometry()

virtual void SimplygonSDK::ISurfaceMapper::SetDestinationGeometry ( IGeometryData *  value )

pure virtual

Set the destination geometry data

Parameters

value

is the destination geometry

SetDestinationScene()

virtual void SimplygonSDK::ISurfaceMapper::SetDestinationScene ( IScene *  value )

pure virtual

Set the scene used for the surface transfer destination

Parameters

value

is the destination scene object

SetDestinationTexCoordSet()

virtual void SimplygonSDK::ISurfaceMapper::SetDestinationTexCoordSet ( rid  value )

pure virtual

Set the texcoord level in the destination geom to use for the material transfer

Parameters

value

is the texcoord level

SetRecalculateSearchDirection()

virtual void SimplygonSDK::ISurfaceMapper::SetRecalculateSearchDirection ( bool  value )

pure virtual

Set the RecalculateSearchDirection flag. If set, the search direction from the destination mesh to the source mesh will be determined by an internal normal calculation with the specified hard edge angle. If false, the search direction will be determined by the existing normals of the destination geometry.

Parameters

value

is the desired flag value

SetSearchDirectionHardEdgeAngleInRadians()

virtual void SimplygonSDK::ISurfaceMapper::SetSearchDirectionHardEdgeAngleInRadians ( real  value )

pure virtual

Set the hard edge angle. If RecalculateSearchDirection is on, the search direction from the destination mesh to the source mesh will be determined by an internal normal calculation with the specified hard edge angle. If false, the search direction will be determined by the existing normals of the destination geometry.

Parameters

value

is the hard angle value

SetSearchDistance()

virtual void SimplygonSDK::ISurfaceMapper::SetSearchDistance ( real  value )

pure virtual

Set the search distance. If the source geometry is found within this distance from the destination geometry, it will be mapped. If negative, it will be set to a sane default internally, based on the mesh size.

Parameters

value

is the search distance value

SetSearchOffset()

virtual void SimplygonSDK::ISurfaceMapper::SetSearchOffset ( real  value )

pure virtual

Set the search offset. This is how far out from the destination geometry the search for the source geometry will begin, propagating inwardly for the length of SearchDistance. If negative, it will be set to a sane default internally, based on the mesh size.

Parameters

value

is the search offset value

SetSourceGeometry()

virtual void SimplygonSDK::ISurfaceMapper::SetSourceGeometry ( IGeometryData *  value )

pure virtual

Set the source geometry data

Parameters

value

is the source geometry

SetSourceScene()

virtual void SimplygonSDK::ISurfaceMapper::SetSourceScene ( IScene *  value )

pure virtual

Set the scene used for the surface transfer source

Parameters

value

is the source scene object

---

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

• SimplygonSDK.h