artofillusion.texture
Class SphericalMapping

java.lang.Object
  extended by artofillusion.texture.TextureMapping
      extended by artofillusion.texture.Mapping2D
          extended by artofillusion.texture.NonlinearMapping2D
              extended by artofillusion.texture.SphericalMapping

public class SphericalMapping
extends NonlinearMapping2D

SphericalMapping is a Mapping2D which wraps the texture around a sphere.


Field Summary
 
Fields inherited from class artofillusion.texture.TextureMapping
BACK_ONLY, FRONT_AND_BACK, FRONT_ONLY
 
Constructor Summary
SphericalMapping(java.io.DataInputStream in, Object3D theObject, Texture theTexture)
           
SphericalMapping(Object3D theObject, Texture theTexture)
           
 
Method Summary
 void copy(TextureMapping mapping)
          Make this mapping identical to another one.
 TextureMapping duplicate()
          Create a new TextureMapping which is identical to this one.
 TextureMapping duplicate(Object3D obj, Texture tex)
          Create a new TextureMapping which is identical to this one, but for a different object and texture.
 Vec2[] findTextureCoordinates(Mesh mesh)
          Given a Mesh to which this mapping has been applied, return the texture coordinates at each vertex.
 double getDisplaceIntermed(double x, double y, double z, double size, double time, double[] param)
          Same as above, except only return the displacement.
 double getDisplacement(Vec3 pos, double size, double time, double[] param)
          Given a point on the surface, evaluate the displacement function.
 Widget getEditingPanel(Object3D obj, MaterialPreviewer preview)
          This method should return a Widget in which the user can edit the mapping.
static java.lang.String getName()
           
 double getOffset()
          Get the offset (in degrees).
 TextureParameter[] getParameters()
          Get the list of texture parameters associated with this mapping and its texture.
 Mat4 getPreTransform()
          Get the linear transform which maps from object coordinates to intermediate coordinates.
 Vec3 getRotations()
          Get a vector whose components contain the rotation angles for the mapping.
 Vec2 getScale()
          Get a vector whose components contain the scale factors for the mapping.
 void getSpecIntermed(TextureSpec spec, double x, double y, double z, double size, double angle, double time, double[] param)
          Given intermediate texture coordinates, find the surface properties.
 void getTextureSpec(Vec3 pos, TextureSpec spec, double angle, double size, double time, double[] param)
          Given a point on the surface for which this mapping is being used, find the corresponding surface properties.
 void getTransIntermed(RGBColor trans, double x, double y, double z, double size, double angle, double time, double[] param)
          Same as above, except only return the transparent color.
 void getTransparency(Vec3 pos, RGBColor trans, double angle, double size, double time, double[] param)
          Same as above, except only return the transparent color.
 RenderingTriangle mapTriangle(int v1, int v2, int v3, int n1, int n2, int n3, Vec3[] vert)
          Given the vertices to be mapped and their normal vectors, generate a RenderingTriangle.
 void setOffset(double degrees)
          Set the offset (in degrees).
 void setParameters(RenderingTriangle tri, double[] p1, double[] p2, double[] p3, RenderingMesh mesh)
          This method is called once the texture parameters for the vertices of a triangle are known.
 void setRotations(Vec3 angles)
          Set the rotation angles for the mapping.
 void setScale(Vec2 scale)
          Set the scale factors for the mapping.
 void writeToFile(java.io.DataOutputStream out)
          Every subclass of TextureMapping must define a constructor which takes a Texture and an Object3D as its arguments:
 
Methods inherited from class artofillusion.texture.NonlinearMapping2D
isBoundToSurface, setBoundToSurface
 
Methods inherited from class artofillusion.texture.Mapping2D
getObject, getTexture, legalMapping
 
Methods inherited from class artofillusion.texture.TextureMapping
appliesTo, appliesToFace, setAppliesTo
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SphericalMapping

public SphericalMapping(Object3D theObject,
                        Texture theTexture)

SphericalMapping

public SphericalMapping(java.io.DataInputStream in,
                        Object3D theObject,
                        Texture theTexture)
                 throws java.io.IOException,
                        java.io.InvalidObjectException
Throws:
java.io.IOException
java.io.InvalidObjectException
Method Detail

getName

public static java.lang.String getName()

getScale

public Vec2 getScale()
Get a vector whose components contain the scale factors for the mapping.


setScale

public void setScale(Vec2 scale)
Set the scale factors for the mapping.


getRotations

public Vec3 getRotations()
Get a vector whose components contain the rotation angles for the mapping.


setRotations

public void setRotations(Vec3 angles)
Set the rotation angles for the mapping.


getOffset

public double getOffset()
Get the offset (in degrees).


setOffset

public void setOffset(double degrees)
Set the offset (in degrees).


mapTriangle

public RenderingTriangle mapTriangle(int v1,
                                     int v2,
                                     int v3,
                                     int n1,
                                     int n2,
                                     int n3,
                                     Vec3[] vert)
Description copied from class: TextureMapping
Given the vertices to be mapped and their normal vectors, generate a RenderingTriangle. Most subclasses will override this method. However, some mappings which require more information than just the vertex coordinates may instead define new methods which replace this one.

Overrides:
mapTriangle in class TextureMapping

setParameters

public void setParameters(RenderingTriangle tri,
                          double[] p1,
                          double[] p2,
                          double[] p3,
                          RenderingMesh mesh)
This method is called once the texture parameters for the vertices of a triangle are known.

Overrides:
setParameters in class TextureMapping

getTextureSpec

public void getTextureSpec(Vec3 pos,
                           TextureSpec spec,
                           double angle,
                           double size,
                           double time,
                           double[] param)
Description copied from class: TextureMapping
Given a point on the surface for which this mapping is being used, find the corresponding surface properties. The properties should be averaged over a region around the point.

Specified by:
getTextureSpec in class TextureMapping
Parameters:
pos - the point at which to evaluate the texture
spec - the surface properties will be stored in this
angle - the dot product of the view direction with the surface normal
size - the width of the region over which to average the surface properties
time - the time at which to evaluate the surface properties
param - the texture parameter values at the point

getDisplacement

public double getDisplacement(Vec3 pos,
                              double size,
                              double time,
                              double[] param)
Description copied from class: TextureMapping
Given a point on the surface, evaluate the displacement function. All parameters are the same as for getTextureSpec().

Specified by:
getDisplacement in class TextureMapping

getTransparency

public void getTransparency(Vec3 pos,
                            RGBColor trans,
                            double angle,
                            double size,
                            double time,
                            double[] param)
Description copied from class: TextureMapping
Same as above, except only return the transparent color. This can save time in cases where only the transparency is required, for example, when tracing shadow rays.

Specified by:
getTransparency in class TextureMapping

getPreTransform

public Mat4 getPreTransform()
Description copied from class: NonlinearMapping2D
Get the linear transform which maps from object coordinates to intermediate coordinates.

Specified by:
getPreTransform in class NonlinearMapping2D

getSpecIntermed

public void getSpecIntermed(TextureSpec spec,
                            double x,
                            double y,
                            double z,
                            double size,
                            double angle,
                            double time,
                            double[] param)
Description copied from class: NonlinearMapping2D
Given intermediate texture coordinates, find the surface properties. size is the width of the area over which the properties should be averaged.

Specified by:
getSpecIntermed in class NonlinearMapping2D

getTransIntermed

public void getTransIntermed(RGBColor trans,
                             double x,
                             double y,
                             double z,
                             double size,
                             double angle,
                             double time,
                             double[] param)
Description copied from class: NonlinearMapping2D
Same as above, except only return the transparent color. This can save time in cases where only the transparency is required, for example, when tracing shadow rays.

Specified by:
getTransIntermed in class NonlinearMapping2D

getDisplaceIntermed

public double getDisplaceIntermed(double x,
                                  double y,
                                  double z,
                                  double size,
                                  double time,
                                  double[] param)
Description copied from class: NonlinearMapping2D
Same as above, except only return the displacement.

Specified by:
getDisplaceIntermed in class NonlinearMapping2D

findTextureCoordinates

public Vec2[] findTextureCoordinates(Mesh mesh)
Given a Mesh to which this mapping has been applied, return the texture coordinates at each vertex.

Specified by:
findTextureCoordinates in class Mapping2D

duplicate

public TextureMapping duplicate()
Description copied from class: TextureMapping
Create a new TextureMapping which is identical to this one.

Specified by:
duplicate in class TextureMapping

duplicate

public TextureMapping duplicate(Object3D obj,
                                Texture tex)
Description copied from class: TextureMapping
Create a new TextureMapping which is identical to this one, but for a different object and texture.

Specified by:
duplicate in class TextureMapping

copy

public void copy(TextureMapping mapping)
Description copied from class: TextureMapping
Make this mapping identical to another one.

Specified by:
copy in class TextureMapping

getParameters

public TextureParameter[] getParameters()
Description copied from class: TextureMapping
Get the list of texture parameters associated with this mapping and its texture. Subclasses that define their own parameters should override this to add them to the list.

Overrides:
getParameters in class TextureMapping

getEditingPanel

public Widget getEditingPanel(Object3D obj,
                              MaterialPreviewer preview)
Description copied from class: TextureMapping
This method should return a Widget in which the user can edit the mapping. The parameters are the object whose mapping is being edited, and a MaterialPreviewer which should be rendered whenever one of the mapping's parameters changes.

Specified by:
getEditingPanel in class TextureMapping

writeToFile

public void writeToFile(java.io.DataOutputStream out)
                 throws java.io.IOException
Description copied from class: TextureMapping
Every subclass of TextureMapping must define a constructor which takes a Texture and an Object3D as its arguments:

public MappingSubclass(Object3D obj, Texture texture)

In addition, every subclass must include a method of the form

public static boolean legalMapping(Object3D obj, Texture texture)

which returns true if the mapping can be used with the specified object and Texture. Finally, every subclass must include a constructor with the signature

public MappingSubclass(DataInputStream in, Object3D obj, Texture texture) throws IOException, InvalidObjectException

which reconstructs the mapping by reading its data from an input stream. The following method writes the object's data to an output stream.

Specified by:
writeToFile in class TextureMapping
Throws:
java.io.IOException


Copyright © 1999-2011 by Peter Eastman.