Simplygon 9 Documentation

# class MappingImage

MappingImage 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.

# Properties

Property Description
Name The name of the MappingImage object. (Inherited from Object)

# 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 MappingImage class. (Inherited from Object)
GetHeight The height of the mapping texture.
GetImageData The ImageData object, which stores the mapping data.
GetLayerCount The number of layers of the mapping texture.
GetMappingMeshData The IMappingImageMeshData Mesh data that is used to retrieve the triangle mapping to mesh information to map back to the original scene.
GetMultisamplingHeight The multi sampling height of the mapping texture.
GetMultisamplingWidth The multi sampling width of the mapping texture.
GetWidth The width of the mapping texture.
IsA Returns true if MappingImage is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull Returns true if the MappingImage object is invalid. (Inherited from Object)
IsSameObjectAs Returns true if the MappingImage object is valid. (Inherited from Object)
NewQuartersizeCopy 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 its name.
NonNull Returns true if the MappingImage object is valid. (Inherited from Object)
PrintInfo Prints the content/info of the MappingImage object to the log. (Inherited from Object)
RemoveObserver Removes a previously added observer object. (Inherited from Object)

# 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 spMappingImage, and if this is the case, returns the object cast into spMappingImage. (Inherited from Object)

# Properties details

# Name

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

    # Methods details

    # 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 MappingImage class. (Inherited from Object)

        # GetHeight

        The height of the mapping texture.

          # GetImageData

          The ImageData object, which stores the mapping data.

            # GetLayerCount

            The number of layers of the mapping texture.

              # GetMappingMeshData

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

                # GetMultisamplingHeight

                The multi sampling height of the mapping texture.

                  # GetMultisamplingWidth

                  The multi sampling width of the mapping texture.

                    # GetWidth

                    The width of the mapping texture.

                      # IsA

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

                        # IsNull

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

                          # IsSameObjectAs

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

                            # NewQuartersizeCopy

                            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 its name.

                              # NonNull

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

                                # PrintInfo

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

                                  # RemoveObserver

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

                                    # 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)

                                      # SafeCast

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

                                        ← MappingImageMeshData →