Inartis
About Inartis  |   Shopping Cart  |  
Kribi 3D
Product
Resources
Download
Purchase
Resources Feature Lab Getting Started Basic Concepts Api’s References
Kribi 3D Player Api's Reference
 
  • API Interface
  • API Syntax
  • API's References
    • Animation
    • Assemblies
      • Assembly overview
      • Child Hook
      • Hot Segment
      • Hot Spot
      • Parent Hook
    • Background
    • Camera
    • Color
    • Instance
    • Light Source
    • Material and Maps
      • Material
      • Material /Maps
    • Model
    • Object
    • Picture
    • Player
    • Player Signals
    • Polygonal Modeling
      • Modeling overview
      • Face
      • Mesh
      • Vertex
    • Realistic Light
    • Realistic Lighting
    • Renderer
    • Script
    • Snapshot
    • Solid Texturing
      • Color Map
      • Color Map Strip
      • Noise Generator
      • Solid Texture
      • Solid Texture Component
    • Interactive Tools
      • Tool
      • Tool /Camera Clip
      • Tool /Camera Move
      • Tool /Camera Orbit
      • Tool /Camera Rotate
      • Tool /Camera Walk
      • Tool /Camera Zoom
      • Tool /Instance Move
      • Tool /Instance Rotate
      • Tool /Instance Size
      • Tool Preferences
    • View
    • Work Light
    • Work Lighting
Material /Maps
last update: 26 june 2011
 
Maps can be associated with the different components of a material in order to simulate textures, highlights and other effects.
 
Overview
 
Texture Mapping
   
  The texture, also called texture map, is a bitmap Picture which is used to add a pattern to an object’s surface, like a transfer. Texture maps are useful to simulate different kinds of material. For example it is possible to use the image of a certain wood to give a floor a parquetted look, or the image of a brick to decorate a wall.The texture map is projected on an object’s surface and in order to specify the way the texture is projected, it is necessary to set some coordinates.

The coordinates specify the position, the orientation, and the scale of the map on the geometry of the object’s surface. The coordinates are often referred to as U and V (UV map) where U is the horizontal dimension, and V is the vertical dimension on the map in its local coordinate system. U and V are used as an alternative to X and Y which are instead used on the geometrical space of the objects.
   
 
Texture Projection
  Select the Texture Projection mode to choose the method of geometrical projection of the map on the object’s surface:
   
  The UV mapping is usually used on irregular surfaces as it allows the texture map to stick and stretch with the surface. The UV Mapping process involves all the polygons which constitute a 3D object. For example it is possible to copy a triangular shaped piece of the bitmap picture and paste it on a triangle forming part of the object’s surface. If the surface contracts or expands the bitmap does the same.
   
  X, Y or Z Parallel: projects the texture map from a single flat surface onto the object parallel to the X, Y or Z axis of the object itself; in the same way a slide is projected. Parallel projection is useful when only one side of the object needs to be mapped.
   
  X, Y, or Z Wrap: projects the texture map from a cylinder, wrapping it around the object. Wrap mapping is useful when the object has cylindrical shapes.
   
  Spherical: surrounds the object projecting the texture map from a sphere. Spherical mapping is useful when the object has spherical shapes.
   
Texture
  Set the Texture value to choose the bitmap picture to be used as texture map. This value is associated with a picture.
   
Texture Amount
  Set the Texture Amount value to adjust the texture map incidence on the material. This value can range from 0% to 100%, with 100% being the default setting. At 100% the texture map completely covers the material, while at 50% the texture map is transparent and the ambient and the diffuse color of the material can be seen through the map.
   
Texture Interpolation
  Toggle the Picture Interpolation check box ON to calculate the interpolation when the bitmap picture is enlarged; toggle the value OFF to disable the interpolation of the bitmap picture.
   
Texture Tiling
  When applying a texture map, especially if the map is a pattern, you will often want the pattern to be repeated. This effect is called tiling.
Toggle the Texture Tiling check box ON to repeat the bitmap picture on the object’s surface. Toggle the value OFF to disable the tiling. The value is ON by default.
   
Scale
  Set the Scale value to increase or decrease the scale of the texture map. Positive numerical values are accepted. By default the scale of the associated bitmap picture is applied.
   
Texture Scales X and Y
  Set the X and Y Scale values to deform the texture map independently along the X and Y axes. Positive numerical values are accepted.
   
Texture Offsets X and Y
  Set the X and Y Offset values to adjust the position of the texture map on the object’s surface along the X and Y axes. Positive numerical values are accepted; the value is 0 by default.
 
Reflection Map
   
  It is possible to use a bitmap picture as a reflection map. The aim of reflection maps is to improve the realism of a surface, for example to give the illusion of chromium plating, of glass or metal on a surface.

The picture is reflected on the object’s surface. A better result is achieved increasing the Specular value. The reflection map is also influenced by ambient and diffuse colors; the darker the color, the stronger the mirror effect.
   
 
Reflection
  Set the Reflection value to adjust the degree of reflection on the object’s surface. This parameter can range from 0% to 100%, with 100% being the default setting. High values increase the reflection, while low values decrease the reflection level.
   
Reflection Color
Set a Reflection Color value to choose the color of the reflection on surfaces. This value is associated with a color.
   
Reflection Map
  Set the Reflection Map value to choose the picture to be used as reflection map. This value is associated with a picture.
   
Reflection Map Type
  Select the Reflection Map Type mode to choose the method for render reflective surface:
   
  Cube: Reflect on the surface a surrounding environment, set a valid cube map picture for the ReflectionMap properties.
   
  Sphere: approximates reflective surfaces by considering a picture to be an infinitely distance on a spherical plane.
 
  Bump Mapping
   
  The bump mapping is used to give an irregular and in relief appearance to an object’s surface using a bitmap picture. The bump mapping effect is a simulation during the rendering process. This means that the geometry of the object is not modified and that its silhouette and the shades that it casts are not affected.

The bump mapping uses the bitmap picture’s contrast to affect the relief of the surface; white areas appear to be protruding, while black areas are flatter. Maps shading from black to white give better results than those with more neat differences between the two colors.
   
 
Bumpiness
  Set the Bumpiness value to adjust the degree of relief on the object’s surface. This value can range from 0% to 100%; value is  0% by default. High values will increase the relief, while low values will decrease the in relief effect.
   
Bump Map
  Set the Bump Map value to choose the image to be used as bump map. This value is associated with a picture.
   
Bump Map Projection
  The bump map is projected on an object’s surface in the same way as the texture map and to specify the way it is projected, it is necessary to set some coordinates. The coordinates specify the position, the orientation and the scale of the map on the geometry of the object’s surface.

In order to achieve better results we recommend setting the same projection method for both the texture map and the bump map.

Select the Bump Map mode to choose the method of geometrical projection of the bump map on the object’s surface:
   
  The UV mapping is usually used on irregular surfaces as it allows the bump map to stick to and stretch with the surface.
   
  Parallel X, Y or Z: projects the bump map from a single flat surface onto the object parallel to the X, Y or Z axis of the object itself; in the same way a slide is projected. Parallel projection is useful when only one side of the object needs a bump.
   
  X, Y, or Z Wrap: projects the bump map from a cylinder, wrapping it around the object. Wrap mapping is useful when the object has cylindrical shapes.
   
  Spherical: surrounds the object projecting the bump map from a sphere. Spherical mapping is useful when the object has spherical shapes.
   
Bump Scale X e Y
  Set the X and Y Bump Scales values to deform the bump map along the X and Y axes. Positive numerical values are accepted.
 
  Anisotropy Map
   
  Anisotropy casts elliptical shaped highlights on surfaces. This kind of highlights is useful in simulating glass or brushed metals. The anisotropy effect is not very evident if the specular level is not high enough.
   
 
Anisotropy
  Set the Anisotropy value to control the shape of the highlight. Valid values range between 0% and 100%. At 0% the highlight is circular, while at 100% the highlight is very narrow.
   
Orientation
  Set the Orientation value to control the position of the anisotropic highlight. Valid values range between 0 and 180 degrees, with 0 being the default value.
   
Orientation Map
  It is possible to use a bitmap picture in order to change the highlights’ position. Maps with very dark or bright values are not very effective, while maps with a correctly balanced grey scale are very effective.

Set the Orient Map value to choose the image to be used for the anisotropy orientation. This value is associated with a picture.
   
Orientation Scales X and Y
  Set the Orientation Scale X and Y values to adapt the scale of the bitmap used as anisotropy orientation map. Positive numerical values are accepted.
 
Programming
 
All commands are sent to the Kribi 3D Player by using the Do() method. This method accepts a string  which defines the command to be executed.
 
Properties
 

Notation

Parameters

Return value(s)

ED

Material AnisotropyOrientationMap

Material[index] AnisotropyOrientationMap

Material['name'] AnisotropyOrientationMap

 

Gets the anisotropy orientation map index of either the current, index or name material.

 

Default value:        null

index : Integer

name : String

index : Integer

P

Material AnisotropyOrientationMap pictureindex

Material AnisotropyOrientationMap 'picturename'

Material AnisotropyOrientationMap null

Material[index] AnisotropyOrientationMap pictureindex

Material[index] AnisotropyOrientationMap 'picturename'

Material[index] AnisotropyOrientationMap null

Material['name'] AnisotropyOrientationMap pictureindex

Material['name'] AnisotropyOrientationMap 'picturename'

Material['name'] AnisotropyOrientationMap null

 

Gets the anisotropy orientation map index of either the current, index or name material.

 

Sets the anisotropy orientation map to pictureindex,  picturename or null either for the current, index or name material.

index : Integer

name : String

pictureindex : Integer

picturename : String

index : Integer

P

Material AnisotropyOrientationScales

Material[index] AnisotropyOrientationScales

Material['name'] AnisotropyOrientationScales

 

Gets the anisotropy orientation scales u,v of either the current, index or name material.

 

Default values:        1.0,1.0

Range:        +/- [1e-9,1e9]

index : Integer

name : String

u,v : Real

P

Material AnisotropyOrientationScales u,v

Material[index] AnisotropyOrientationScales u,v

Material['name'] AnisotropyOrientationScales u,v

 

Gets the anisotropy orientation scales u,v of either the current, index or name material.

 

Sets the material anisotropy orientation scales to u,v either for the current, index or name material.

u,v : Real

index : Integer

name : String

u,v : Real

P

Material Bumpiness

Material[index] Bumpiness

Material['name'] Bumpiness

 

Gets the bumpiness value of either the current, index or name material.

 

Default value:        0.25

Range:        [0.0,1.0]

index : Integer

name : String

value : Real

P

Material Bumpiness value

Material[index] Bumpiness value

Material['name'] Bumpiness value

 

Gets the bumpiness value of either the current, index or name material.

 

Sets the bumpiness to value either for the current, index or name material.

value : Real

index : Integer

name : String

value : Real

P

Material BumpMap

Material[index] BumpMap

Material['name'] BumpMap

 

Gets the bump map index of either the current, index or name material.

 

Default value:        null

index : Integer

name : String

index: Integer

P

Material BumpMap pictureindex

Material BumpMap 'picturename'

Material BumpMap null

Material[index] BumpMap pictureindex

Material[index] BumpMap 'picturename'

Material[index] BumpMap null

Material['name'] BumpMap pictureindex

Material['name'] BumpMap 'picturename'

Material['name'] BumpMap null

 

Gets the bump map index of either the current, index or name material.

 

Sets the bump map pictureindex, picturename or null either for the current, index or name material.

index : Integer

name : String

pictureindex : Integer

picturename : String

index : Integer

P

Material BumpMapProjection

Material[index] BumpMapProjection

Material['name'] BumpMapProjection

 

Gets the bump map projection mode of either the current, index or name material.

 

Default value:        X

index : Integer

name : String

 

mode : Enumeration

P

Material BumpMapProjection mode

Material[index] BumpMapProjection mode

Material['name'] BumpMapProjection mode

 

Gets the bump map projection mode of either the current, index or name material.

 

Sets the bump map projection mode among these different options either for the current, index or name material :

Null

Spherical

WrapX

WrapY

WrapZ

X

Y

Z

mode : Enumeration

index : Integer

name : String

mode : Enumeration

P

Material BumpScales

Material[index] BumpScales

Material['name'] BumpScales

 

Gets the bump map scales u,v of either the current, index or name material.

 

Default values:        1.0,1.0

Range:        +/- [1e-9,1e9]

index : Integer

name : String

u,v : Real

P

Material BumpScales u,v

Material[index] BumpScales u,v

Material['name'] BumpScales u,v

 

Gets the bump map scales u,v of either the current, index or name material.

 

Sets the bump scales to u,v either for the current, index or name material.

u,v : Real

index : Integer

name : String

u,v : Real

P

Material ColorMap

Material[index] ColorMap

Material['name'] ColorMap

 

 

Gets the color map index of either the current, index or name material.

 

Default value:        null

index : Integer

name : String

index : Integer

P

Material ColorMap colormapindex

Material ColorMap 'colormapname'

Material ColorMap null

Material[index] ColorMap colormapindex

Material[index] ColorMap 'colormapname'

Material[index] ColorMap null

Material['name'] ColorMap colormapindex

Material['name'] ColorMap 'colormapname'

Material['name'] ColorMap null

 

Gets the color map index of either the current, index or name material.

 

Sets the color map to colormapindex, colormapname or null either for the current, index or name material.

index : Integer

name : String

colormapindex : Integer

colormapname : Integer

index : Integer

P

Material Reflection

Material[index] Reflection

Material['name'] Reflection

 

Gets the reflection coefficient value of either the current, index or name material.

 

Default value:        0.5

Range:        [0.0,1.0]

index : Integer

name : String

value : Real

P

Material Reflection

Material[index] Reflection value

Material['name'] Reflection value

 

Gets the reflection coefficient value of either the current, index or name material.

 

Sets the reflection coefficient to value either for the current, index or name material.

value : Real

index : Integer

name : String

value : Real

P

Material ReflectionColor

Material[index] ReflectionColor

Material['name'] ReflectionColor

 

Gets the reflection color index of either the current, index or name material.

 

Default value:        null

index : Integer

name : String

index : Integer

P

Material ReflectionColor colorindex

Material ReflectionColor 'colorname'

Material ReflectionColor null

Material[index] ReflectionColor colorindex

Material[index] ReflectionColor 'colorname'

Material[index] ReflectionColor null

Material['name'] ReflectionColor colorindex

Material['name'] ReflectionColor 'colorname'

Material['name'] ReflectionColor null

 

Gets the reflection color index of either the current, index or name material.

 

Sets the reflection color to colorindex, colorname or null either for the current, index or name material.

 

If this property is null the renderer will consider it as a white color (RGB values = 1.0,1.0,1.0).

index : Integer

name : String

colorindex : Integer

colorname : Integer

index : Integer

P

Material ReflectionMap

Material[index] ReflectionMap

Material['name'] ReflectionMap

 

Gets the reflection map index of either the current, index or name material.

 

Default value:        null

index : Integer

name : String

index : Integer

P

Material ReflectionMap pictureindex

Material ReflectionMap 'picturename'

Material ReflectionMap null

Material[index] ReflectionMap pictureindex

Material[index] ReflectionMap 'picturename'

Material[index] ReflectionMap null

Material['name'] ReflectionMap pictureindex

Material['name'] ReflectionMap 'picturename'

Material['name'] ReflectionMap null

 

Gets the reflection map index of either the current, index or name material.

 

Sets the reflection map to pictureindex, picturename or null either for the current, index or name material.

index : Integer

name : String

pictureindex : Integer

picturename : String

 

index : Integer

P

Material ReflectionMapType

Material[index] ReflectionMapType

Material['name'] ReflectionMapType

 

Gets the reflection map type mode of either the current, index or name material.

 

Default value:        Sphere

index : Integer

name : String

 

mode : Enumeration

P

Material ReflectionMapType mode

Material[index] ReflectionMapType mode

Material['name'] ReflectionMapType mode

 

Gets the reflection map type mode of either the current, index or name material.

 

Sets the reflection map type mode among these different options either for the current, index or name material :

Cube

Sphere

mode : Enumeration

index : Integer

name : String

mode : Enumeration

P

Material SolidTexture

Material[index] SolidTexture

Material['name'] SolidTexture

 

Gets the solid texture index of either the current, index or name material.

 

Default value:        null

index : Integer

name : String

index : Integer

P

Material SolidTexture solidtextureindex

Material SolidTexture 'solidtexturename'

Material SolidTexture null

Material[index] SolidTexture solidtextureindex

Material[index] SolidTexture 'solidtexturename'

Material[index] SolidTexture null

Material['name'] SolidTexture solidtextureindex

Material['name'] SolidTexture 'solidtexturename'

Material['name'] SolidTexture null

 

Gets the solid texture index of either the current, index or name material.

 

Sets the diffuse color to solidtextureindex, solidtexturename or null either for the current, index or name material.

index : Integer

name : String

solidtextureindex: Integer

solidtexturename: Integer

index : Integer

P

Material Texture

Material[index] Texture

Material['name'] Texture

 

Gets the texture index of either the current, index or name Material.

 

Default value:        null

index : Integer

name : String

index : Integer

 

Material Texture pictureindex

Material Texture 'picturename'

Material Texture null

Material[index] Texture pictureindex

Material[index] Texture 'picturename'

Material[index] Texture null

Material['name'] Texture pictureindex

Material['name'] Texture 'picturename'

Material['name'] Texture null

 

Gets the texture index of either the current, index or name Material.

 

Sets the texture to pictureindex, picturename or null either for the current, index or name material.

index : Integer

name : String

pictureindex : Integer

picturename : String

index : Integer

 

Material TextureAmount

Material[index] TextureAmount

Material['name'] TextureAmount

 

Gets the texture amount value of either the current, index or name material.

 

Default value:        1.0

Range:        [0.0,1.0]

index : Integer

name : String

 

value : Real

 

Material TextureAmount value

Material[index] TextureAmount value

Material['name'] TextureAmount value

 

Gets the texture amount value of either the current, index or name material.

 

Sets the texture amount to value either for the current, index or name material.

value : Real

index : Integer

name : String

value : Real

 

Material TextureInterpolation

Material[index] TextureInterpolation

Material['name'] TextureInterpolation

 

Gets the texture interpolation mode of either the current, index or name material.

 

Default value:        1

index : Integer

name : String

mode : Boolean

 

Material TextureInterpolation mode

Material[index] TextureInterpolation mode

Material['name'] TextureInterpolation mode

 

Gets the texture interpolation mode of either the current, index or name material.

 

Switches the texture interpolation mode among these different options either for the current, index or name material :

0: Off

1: On

mode : Boolean

index : Integer

name : String

mode : Boolean

 

Material TextureOffsets

Material[index] TextureOffsets

Material['name'] TextureOffsets

 

Gets the texture offsets u,v of either the current, index or name material.

 

Default values:        0.0,0.0

Range:        [-1e6,1e6]

index : Integer

name : String

u,v : Real

 

Material TextureOffsets u,v

Material[index] TextureOffsets u,v

Material['name'] TextureOffsets u,v

 

Gets the texture offsets u,v of either the current, index or name material.

 

Sets the texture offsets to u,v either for the current, index or name material.

u,v : Real

index : Integer

name : String

u,v : Real

 

Material TextureProjection

Material[index] TextureProjection

Material['name'] TextureProjection

 

Gets the texture projection mode of either the current, index or name material.

 

Default value:        X

index : Integer

name : String

mode : Enumeration

 

Material TextureProjection mode

Material[index] TextureProjection mode

Material['name'] TextureProjection mode

 

Gets the texture projection mode of either the current, index or name material.

 

Sets the projection mode among these different options either for the current, index or name material :

Null

Spherical

WrapX

WrapY

WrapZ

X

Y

Z

mode : Enumeration

index : Integer

name : String

mode : Enumeration

 

Material TextureScales

Material[index] TextureScales

Material['name'] TextureScales

 

Gets the texture scales u,v of either the current, index or name material.

 

Default values:        1.0,1.0

Range:        +/- [1e-9,1e9]

index : Integer

name : String

u,v : Real

 

Material TextureScales u,v

Material[index] TextureScales u,v

Material['name'] TextureScales u,v

 

Gets the texture scales u,v of either the current, index or name material.

 

Sets the texture scales to u,v either for the current, index or name material.

u,v : Real

index : Integer

name : String

u,v : Real

 

Material TextureTiling

Material[index] TextureTiling

Material['name'] TextureTiling

 

Gets the texture tiling mode of either the current, index or name material.

 

Default value:        1

index : Integer

name : String

mode : Boolean

 

Material TextureTiling mode

Material[index] TextureTiling mode

Material['name'] TextureTiling mode

 

Gets the texture tiling mode of either the current, index or name material.

 

Switches the texture tiling mode among these different options either for the current, index or name material :

0: Off

1: On

mode : Boolean

index : Integer

name : String

mode : Boolean

 
 
Kribi 3D Engine
 
Kribi 3D Player
Get Kribi 3D Player
License
Plug-in test page
Release Notes
Resources
Feature Lab
Basic Concepts
Getting Started
Api's References
  Kribi 3D Designer
  Download 90 day Trial
  Compare and Buy
  License
  Release Notes
  Product Faq
  About Inartis
  Contact Us
  Services
 
 
Copyrights © 2010-2012 Inartis SA. | PRIVACY | TERMS OF USE