Simplygon 10 Documentation

# class SurfaceMapper

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. If only a single source or a destination is set, or if the source and destination are the same scene or geometry, the surface mapper will map the mesh onto itself.

# Properties

Property Description
DestinationGeometry The destination geometry data.
DestinationScene The scene used for the surface transfer destination.
Name The name of the SurfaceMapper object. (Inherited from Object)
RecalculateSearchDirection 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.
SearchDirectionHardEdgeAngle The hard edge angle in degrees. 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.
SearchDistance 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.
SearchOffset 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.
SourceGeometry The source geometry data.
SourceScene The scene used for the surface transfer source.

# Methods

Method Description
AddObserver Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetClass Get the name of the SurfaceMapper class. (Inherited from Object)
GetMappingImage The mapping image.
GetMappingImageSettings The mapping image settings. Currently, the only applicable settings for this mapper is texcoordlevel, texcoordname, size, and supersampling settings.
IsA Returns true if SurfaceMapper is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull Returns true if the SurfaceMapper object is invalid. (Inherited from Object)
IsSameObjectAs Returns true if the SurfaceMapper object is valid. (Inherited from Object)
NonNull Returns true if the SurfaceMapper object is valid. (Inherited from Object)
PrintInfo Prints the content/info of the SurfaceMapper object to the log. (Inherited from Object)
RemoveObserver Removes a previously added observer object. (Inherited from Object)
RunSurfaceMapping Runs the surface mapping.

# Static methods

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast SafeCast makes sure the input object is of a class that can be cast into spSurfaceMapper, and if this is the case, returns the object cast into spSurfaceMapper. (Inherited from Object)

# Properties details

# DestinationGeometry

The destination geometry data.

# Syntax

// Setter
void SetDestinationGeometry( const spGeometryData & value ) const;

// Getter
spGeometryData GetDestinationGeometry() const;

# SetDestinationGeometry parameters

Type Name Min Max Description
GeometryData value Is the destination geometry.

# GetDestinationGeometry return value

Type: GeometryData

# DestinationScene

The scene used for the surface transfer destination.

# Syntax

// Setter
void SetDestinationScene( const spScene & value ) const;

// Getter
spScene GetDestinationScene() const;

# SetDestinationScene parameters

Type Name Min Max Description
Scene value Is the destination scene object.

# GetDestinationScene return value

Type: Scene

# Name

The name of the SurfaceMapper object. (Inherited from Object)

# Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

# SetName parameters

Type Name Min Max Description
const char * name New name of the object.

# GetName return value

Type: spString

# RecalculateSearchDirection

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.

# Syntax

// Setter
void SetRecalculateSearchDirection( bool value ) const;

// Getter
bool GetRecalculateSearchDirection() const;

# SetRecalculateSearchDirection parameters

Type Name Min Max Description
bool value Is the desired flag value.

# GetRecalculateSearchDirection return value

Type: bool

# SearchDirectionHardEdgeAngle

The hard edge angle in degrees. 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.

# Syntax

// Setter
void SetSearchDirectionHardEdgeAngle( real value ) const;

// Getter
real GetSearchDirectionHardEdgeAngle() const;

# SetSearchDirectionHardEdgeAngle parameters

Type Name Min Max Description
real value 0 180 Is the hard angle value.

# GetSearchDirectionHardEdgeAngle return value

Type: real

Default: 180

# SearchDistance

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.

# Syntax

// Setter
void SetSearchDistance( real value ) const;

// Getter
real GetSearchDistance() const;

# SetSearchDistance parameters

Type Name Min Max Description
real value Is the search distance value.

# GetSearchDistance return value

Type: real

# SearchOffset

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.

# Syntax

// Setter
void SetSearchOffset( real value ) const;

// Getter
real GetSearchOffset() const;

# SetSearchOffset parameters

Type Name Min Max Description
real value Is the search offset value.

# GetSearchOffset return value

Type: real

# SourceGeometry

The source geometry data.

# Syntax

// Setter
void SetSourceGeometry( const spGeometryData & value ) const;

// Getter
spGeometryData GetSourceGeometry() const;

# SetSourceGeometry parameters

Type Name Min Max Description
GeometryData value Is the source geometry.

# GetSourceGeometry return value

Type: GeometryData

# SourceScene

The scene used for the surface transfer source.

# Syntax

// Setter
void SetSourceScene( const spScene & value ) const;

// Getter
spScene GetSourceScene() const;

# SetSourceScene parameters

Type Name Min Max Description
Scene value Is the source scene object.

# GetSourceScene return value

Type: Scene

# Methods details

# AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

# Syntax

rid AddObserver( const spObserver & observer ) const;

# Parameters

Type Name Min Max Description
Observer observer Observer is the object that will receive events.

# Return value

Type: rid

# GetClass

Get the name of the SurfaceMapper class. (Inherited from Object)

# Syntax

spString GetClass() const;

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetMappingImage

The mapping image.

# Syntax

spMappingImage GetMappingImage() const;

# Parameters

GetMappingImage takes no parameters.

# Return value

Type: MappingImage

# GetMappingImageSettings

The mapping image settings. Currently, the only applicable settings for this mapper is texcoordlevel, texcoordname, size, and supersampling settings.

# Syntax

spMappingImageSettings GetMappingImageSettings() const;

# Parameters

GetMappingImageSettings takes no parameters.

# Return value

Type: MappingImageSettings

# IsA

Returns true if SurfaceMapper is a or is a descendant of the class named as the type parameter. (Inherited from Object)

# Syntax

bool IsA( const char * type ) const;

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if SurfaceMapper is, or is a descendant of.

# Return value

Type: bool

# IsNull

Returns true if the SurfaceMapper object is invalid. (Inherited from Object)

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

Returns true if the SurfaceMapper object is valid. (Inherited from Object)

# Syntax

bool IsSameObjectAs( const spObject & object ) const;

# Parameters

Type Name Min Max Description
Object object Object to compare with.

# Return value

Type: bool

# NonNull

Returns true if the SurfaceMapper object is valid. (Inherited from Object)

# Syntax

bool NonNull() const;

# Parameters

NonNull takes no parameters.

# Return value

Type: bool

# PrintInfo

Prints the content/info of the SurfaceMapper object to the log. (Inherited from Object)

# Syntax

void PrintInfo() const;

# Parameters

PrintInfo takes no parameters.

# RemoveObserver

Removes a previously added observer object. (Inherited from Object)

# Syntax

void RemoveObserver( rid observerId ) const;

# Parameters

Type Name Min Max Description
rid observerId ObserverId is the id returned by AddObserver when the observer was added.

# RunSurfaceMapping

Runs the surface mapping.

# Syntax

void RunSurfaceMapping() const;

# Parameters

RunSurfaceMapping takes no parameters.

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

# Syntax

static bool IsClassA( const char * type ) const;

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if the class is, or is a descendant of.

# Return value

Type: bool

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spSurfaceMapper, and if this is the case, returns the object cast into spSurfaceMapper. (Inherited from Object)

# Syntax

static spSurfaceMapper SafeCast( const spObject & object ) const;

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: SurfaceMapper

← TangentCalculator →