com.PostHorizon.renderMan
Interface RenderMan

All Known Implementing Classes:

RIBOut

public interface RenderMan

RenderMan API Binding

This interface defines the Java binding for the RenderMan API. An implementation can be defined such that it can be transparently used by any program calling this binding simply by implementing this interface.

The parameter list mechanism used herein is as follows; for each parameter, a key/value pair should be inserted into a Map which is sent to a method expecting a parameter list. Each key must be a String, either one of the default types (such as RenderMan.P) or one already explicitely defined (via the define() method). The value must be either a single String, Number, Point, or Color, or an array of Strings, primitive numeric types (eg, double[]), Points, or Colors. The value must be of the correct type type. All integral types can be substituted for real numbers, but not vice versa. Further, an array of numbers can be substituted for a single Point, single Color, or an array of these, provided the correct number of numbers is still provided. null can always be sent in place of a parameter list if no parameters are required.

Version:

0.92.5

Author:

Sean Cier (scier@PostHorizon.com)

Field Summary

static java.lang.String	A
static java.lang.String	ABORT
static java.lang.String	AMBIENTLIGHT
static java.lang.String	AMPLITUDE
static java.lang.String	ARCHIVE
static java.lang.String	AVERAGE
static java.lang.String	AZ
static java.lang.String	BACKFACETOLERANCE
static java.lang.String	BACKGROUND
static java.lang.String	BEAMDISTRIBUTION
static Matrix	bezierBasis
static int	BEZIERSTEP
static java.lang.String	BICUBIC
static java.lang.String	BILINEAR
static java.lang.String	BLACK
static FilterFunction	boxFilter
static Matrix	bSplineBasis
static int	BSPLINESTEP
static java.lang.String	BUMPY
static java.lang.String	CAMERA
static java.lang.String	CATMULLCLARK
static Matrix	catmullRomBasis
static FilterFunction	catmullRomFilter
static int	CATMULLROMSTEP
static java.lang.String	CLAMP
static java.lang.String	COMMENT
static java.lang.String	CONEANGLE
static java.lang.String	CONEDELTAANGLE
static java.lang.String	CONSTANT
static java.lang.String	CONSTANTWIDTH
static java.lang.String	COORDINATESYSTEM
static java.lang.String	CORNER
static java.lang.String	CREASE
static java.lang.String	CS
static java.lang.String	CUBIC
static java.lang.String	DEPTHCUE
static java.lang.String	DEPTHFILTER
static java.lang.String	DIFFERENCE
static java.lang.String	DISPLACEMENTBOUND
static java.lang.String	DISPLAY
static java.lang.String	DISTANCE
static java.lang.String	DISTANTLIGHT
static java.lang.String	ENDOFFRAME
static double	EPSILON
static ErrorHandler	errorAbort
static ErrorHandler	errorIgnore
static ErrorHandler	errorPrint
static java.lang.String	EYESPLITS
static boolean	FALSE
static java.lang.String	FILE
static java.lang.String	FLATNESS
static java.lang.String	FOG
static java.lang.String	FOV
static java.lang.String	FRAMEBUFFER
static java.lang.String	FROM
static FilterFunction	gaussianFilter
static java.lang.String	HANDLER
static Matrix	hermiteBasis
static int	HERMITESTEP
static java.lang.String	HIDDEN
static java.lang.String	HOLE
static java.lang.String	IDENTIFIER
static java.lang.String	IGNORE
static double	INFINITY
static java.lang.String	INSIDE
static java.lang.String	INTENSITY
static java.lang.String	INTERPOLATEBOUNDARY
static java.lang.String	INTERSECTION
static java.lang.String	JITTER
static java.lang.String	KA
static java.lang.String	KD
static java.lang.String	KR
static java.lang.String	KS
static java.lang.String	LH
static java.lang.String	LIGHTCOLOR
static java.lang.String	LIMITS
static java.lang.String	LINEAR
static java.lang.String	MATTE
static java.lang.String	MAX
static java.lang.String	MAXDISTANCE
static java.lang.String	METAL
static java.lang.String	MIDPOINT
static java.lang.String	MIN
static java.lang.String	MINDISTANCE
static java.lang.String	MOTIONFACTOR
static java.lang.String	N
static java.lang.String	NAME
static java.lang.String	NG
static java.lang.String	NONPERIODIC
static java.lang.String	NP
static java.lang.String	OBJECT
static java.lang.String	ORIGIN
static java.lang.String	ORTHOGRAPHIC
static java.lang.String	OS
static java.lang.String	OUTSIDE
static java.lang.String	P
static java.lang.String	PAINT
static java.lang.String	PAINTEDPLASTIC
static java.lang.String	PERIODIC
static java.lang.String	PERSPECTIVE
static java.lang.String	PLASTIC
static java.lang.String	POINTLIGHT
static Matrix	powerBasis
static int	POWERSTEP
static java.lang.String	PRIMITIVE
static java.lang.String	PRINT
static RefineFunction	procDelayedReadArchive
static RefineFunction	procDynamicLoad
static RefineFunction	procRunProgram
static java.lang.String	PW
static java.lang.String	PZ
static java.lang.String	RADIUS
static java.lang.String	RASTER
static java.lang.String	RGB
static java.lang.String	RGBA
static java.lang.String	RGBAZ
static java.lang.String	RGBZ
static java.lang.String	RH
static java.lang.String	ROUGHNESS
static java.lang.String	S
static java.lang.String	SCREEN
static java.lang.String	SEARCHPATH
static java.lang.String	SHADER
static java.lang.String	SHINYMETAL
static java.lang.String	SIDES
static FilterFunction	sincFilter
static java.lang.String	SMOOTH
static java.lang.String	SPECULARCOLOR
static java.lang.String	SPHERE
static java.lang.String	SPOTLIGHT
static java.lang.String	ST
static java.lang.String	STATISTICS
static java.lang.String	STRUCTURE
static java.lang.String	T
static java.lang.String	TEXTURE
static java.lang.String	TEXTURENAME
static java.lang.String	TO
static java.lang.String	TRANSFORM
static FilterFunction	triangleFilter
static java.lang.String	TRIMDEVIATION
static boolean	TRUE
static java.lang.String	UNION
static java.lang.String	WIDTH
static java.lang.String	WORLD
static java.lang.String	Z

Method Summary

void	archiveRecord(java.lang.String type, java.lang.String s)
LightHandle	areaLightSource(java.lang.String name, java.util.Map params)
void	atmosphere(java.lang.String name, java.util.Map params)
void	attribute(java.lang.String name, java.util.Map params)
void	attributeBegin()
void	attributeEnd()
void	basis(Matrix ubasis, int ustep, Matrix vbasis, int vstep)
void	begin()
void	bound(Bound bound)
void	clipping(double near, double far)
void	color(Color c)
void	colorSamples(int n, double[] nRGB, double[] RGBn)
void	concatTransform(Matrix transform)
void	cone(double height, double radius, double thetamax, java.util.Map params)
void	coordinateSystem(java.lang.String space)
void	coordSysTransform(java.lang.String coordinatesystem)
void	cropWindow(double xmin, double xmax, double ymin, double ymax)
void	curves(java.lang.String type, int ncurves, int[] nvertices, java.lang.String wrap, java.util.Map params)
void	cylinder(double radius, double zmin, double zmax, double thetamax, java.util.Map params)
java.lang.String	declare(java.lang.String name, java.lang.String declaration)
void	deformation(java.lang.String name, java.util.Map params)
void	depthOfField(double fstop, double focallength, double focaldistance)
void	detail(Bound bound)
void	detailRange(double offlow, double onlow, double onhigh, double offhigh)
void	disk(double height, double radius, double thetamax, java.util.Map params)
void	displacement(java.lang.String name, java.util.Map params)
void	display(java.lang.String name, java.lang.String type, java.lang.String mode, java.util.Map params)
void	end()
void	errorHandler(ErrorHandler handler)
void	exposure(double gain, double gamma)
void	exterior(java.lang.String name, java.util.Map params)
void	format(int xresolution, int yresolution, double pixelaspectratio)
void	frameAspectRatio(double frameaspectratio)
void	frameBegin(int number)
void	frameEnd()
void	generalPolygon(int nloops, int[] nvertices, java.util.Map params)
void	geometricApproximation(java.lang.String type, double value)
void	geometry(java.lang.String type, java.util.Map params)
void	hider(java.lang.String type, java.util.Map params)
void	hyperboloid(Point point1, Point point2, double thetamax, java.util.Map params)
void	identity()
void	illuminate(LightHandle light, boolean onoff)
void	imager(java.lang.String name, java.util.Map params)
void	interior(java.lang.String name, java.util.Map params)
LightHandle	lightSource(java.lang.String name, java.util.Map params)
void	makeBump(java.lang.String imagefile, java.lang.String bumpfile, java.lang.String swrap, java.lang.String twrap, FilterFunction filter, double swidth, double twidth, java.util.Map params)
void	makeCubeFaceEnvironment(java.lang.String px, java.lang.String nx, java.lang.String py, java.lang.String ny, java.lang.String pz, java.lang.String nz, java.lang.String reflfile, double fov, FilterFunction filter, double swidth, double twidth, java.util.Map params)
void	makeLatLongEnvironment(java.lang.String imagefile, java.lang.String reflfile, FilterFunction filter, double swidth, double twidth, java.util.Map params)
void	makeShadow(java.lang.String imagefile, java.lang.String shadowfile, java.util.Map params)
void	makeTexture(java.lang.String imagefile, java.lang.String texturefile, java.lang.String swrap, java.lang.String twrap, FilterFunction filter, double swidth, double twidth, java.util.Map params)
void	matte(boolean onoff)
void	motionBegin(double t0, double t1)
void	motionBegin(int n, double[] time)
void	motionEnd()
void	nuPatch(int nu, int uorder, double[] uknot, double umin, double umax, int nv, int vorder, double[] vknot, double vmin, double vmax, java.util.Map params)
ObjectHandle	objectBegin()
void	objectEnd()
void	objectInstance(ObjectHandle handle)
void	opacity(Color o)
void	option(java.lang.String name, java.util.Map params)
void	orientation(java.lang.String orientation)
void	paraboloid(double rmax, double zmin, double zmax, double thetamax, java.util.Map params)
void	patch(java.lang.String type, java.util.Map params)
void	patchMesh(java.lang.String type, int nu, java.lang.String uwrap, int nv, java.lang.String vwrap, java.util.Map params)
void	perspective(double fov)
void	pixelFilter(FilterFunction filterfunc, double xwidth, double ywidth)
void	pixelSamples(double xsamples, double ysamples)
void	pixelVariance(double variation)
void	points(int npoints, java.util.Map params)
void	pointsGeneralPolygons(int npolys, int[] nloops, int[] nvertices, int[] vertices, java.util.Map params)
void	pointsPolygons(int npolys, int[] nvertices, int[] vertices, java.util.Map params)
void	polygon(int nvertices, java.util.Map params)
void	procedural(java.lang.Object data, Bound bound, RefineFunction refineproc)
void	projection(java.lang.String name, java.util.Map params)
void	quantize(java.lang.String type, int one, int min, int max, double ditheramplitude)
void	readArchive(java.lang.String filename, java.util.Map params)
void	relativeDetail(double relativedetail)
void	reverseOrientation()
void	rotate(double angle, double dx, double dy, double dz)
void	scale(double sx, double sy, double sz)
void	screenWindow(double left, double right, double bottom, double top)
void	shadingInterpolation(java.lang.String type)
void	shadingRate(double size)
void	shutter(double min, double max)
void	sides(int nsides)
void	skew(double angle, double dx1, double dy1, double dz1, double dx2, double dy2, double dz2)
void	solidBegin(java.lang.String type)
void	solidEnd()
void	sphere(double radius, double zmin, double zmax, double thetamax, java.util.Map params)
void	subdivisionMesh(java.lang.String scheme, int nfaces, int[] nvertices, int[] vertices, int ntags, java.lang.String[] tags, int[] nargs, int[] intargs, double[] floatargs, java.util.Map params)
void	surface(java.lang.String name, java.util.Map params)
void	textureCoordinates(double s1, double t1, double s2, double t2, double s3, double t3, double s4, double t4)
void	torus(double majorradius, double minorradius, double phimin, double phimax, double thetamax, java.util.Map params)
void	transform(Matrix transform)
void	transformBegin()
void	transformEnd()
Point[]	transformPoints(java.lang.String fromspace, java.lang.String tospace, int npoints, Point[] points)
void	translate(double dx, double dy, double dz)
void	trimCurve(int nloops, int[] ncurves, int[] order, double[] knot, double[] min, double[] max, int[] n, double[] u, double[] v, double[] w)
void	worldBegin()
void	worldEnd()

Field Detail

FRAMEBUFFER

public static final java.lang.String FRAMEBUFFER

FILE

public static final java.lang.String FILE

RGB

public static final java.lang.String RGB

RGBA

public static final java.lang.String RGBA

RGBZ

public static final java.lang.String RGBZ

RGBAZ

public static final java.lang.String RGBAZ

A

public static final java.lang.String A

Z

public static final java.lang.String Z

AZ

public static final java.lang.String AZ

PERSPECTIVE

public static final java.lang.String PERSPECTIVE

ORTHOGRAPHIC

public static final java.lang.String ORTHOGRAPHIC

HIDDEN

public static final java.lang.String HIDDEN

PAINT

public static final java.lang.String PAINT

CONSTANT

public static final java.lang.String CONSTANT

SMOOTH

public static final java.lang.String SMOOTH

FLATNESS

public static final java.lang.String FLATNESS

FOV

public static final java.lang.String FOV

MOTIONFACTOR

public static final java.lang.String MOTIONFACTOR

TRIMDEVIATION

public static final java.lang.String TRIMDEVIATION

AMBIENTLIGHT

public static final java.lang.String AMBIENTLIGHT

POINTLIGHT

public static final java.lang.String POINTLIGHT

DISTANTLIGHT

public static final java.lang.String DISTANTLIGHT

SPOTLIGHT

public static final java.lang.String SPOTLIGHT

MATTE

public static final java.lang.String MATTE

METAL

public static final java.lang.String METAL

SHINYMETAL

public static final java.lang.String SHINYMETAL

PLASTIC

public static final java.lang.String PLASTIC

PAINTEDPLASTIC

public static final java.lang.String PAINTEDPLASTIC

KA

public static final java.lang.String KA

KD

public static final java.lang.String KD

KR

public static final java.lang.String KR

KS

public static final java.lang.String KS

AMPLITUDE

public static final java.lang.String AMPLITUDE

BACKGROUND

public static final java.lang.String BACKGROUND

BEAMDISTRIBUTION

public static final java.lang.String BEAMDISTRIBUTION

CONEANGLE

public static final java.lang.String CONEANGLE

CONEDELTAANGLE

public static final java.lang.String CONEDELTAANGLE

DISTANCE

public static final java.lang.String DISTANCE

FROM

public static final java.lang.String FROM

INTENSITY

public static final java.lang.String INTENSITY

LIGHTCOLOR

public static final java.lang.String LIGHTCOLOR

MAXDISTANCE

public static final java.lang.String MAXDISTANCE

MINDISTANCE

public static final java.lang.String MINDISTANCE

ROUGHNESS

public static final java.lang.String ROUGHNESS

SPECULARCOLOR

public static final java.lang.String SPECULARCOLOR

TEXTURENAME

public static final java.lang.String TEXTURENAME

TO

public static final java.lang.String TO

DEPTHCUE

public static final java.lang.String DEPTHCUE

FOG

public static final java.lang.String FOG

BUMPY

public static final java.lang.String BUMPY

RASTER

public static final java.lang.String RASTER

SCREEN

public static final java.lang.String SCREEN

CAMERA

public static final java.lang.String CAMERA

WORLD

public static final java.lang.String WORLD

OBJECT

public static final java.lang.String OBJECT

INSIDE

public static final java.lang.String INSIDE

OUTSIDE

public static final java.lang.String OUTSIDE

LH

public static final java.lang.String LH

RH

public static final java.lang.String RH

P

public static final java.lang.String P

PZ

public static final java.lang.String PZ

PW

public static final java.lang.String PW

N

public static final java.lang.String N

NP

public static final java.lang.String NP

NG

public static final java.lang.String NG

CS

public static final java.lang.String CS

OS

public static final java.lang.String OS

S

public static final java.lang.String S

T

public static final java.lang.String T

ST

public static final java.lang.String ST

WIDTH

public static final java.lang.String WIDTH

CONSTANTWIDTH

public static final java.lang.String CONSTANTWIDTH

RADIUS

public static final java.lang.String RADIUS

BILINEAR

public static final java.lang.String BILINEAR

BICUBIC

public static final java.lang.String BICUBIC

PRIMITIVE

public static final java.lang.String PRIMITIVE

INTERSECTION

public static final java.lang.String INTERSECTION

UNION

public static final java.lang.String UNION

DIFFERENCE

public static final java.lang.String DIFFERENCE

PERIODIC

public static final java.lang.String PERIODIC

NONPERIODIC

public static final java.lang.String NONPERIODIC

CLAMP

public static final java.lang.String CLAMP

BLACK

public static final java.lang.String BLACK

IGNORE

public static final java.lang.String IGNORE

PRINT

public static final java.lang.String PRINT

ABORT

public static final java.lang.String ABORT

HANDLER

public static final java.lang.String HANDLER

ORIGIN

public static final java.lang.String ORIGIN

IDENTIFIER

public static final java.lang.String IDENTIFIER

NAME

public static final java.lang.String NAME

COMMENT

public static final java.lang.String COMMENT

STRUCTURE

public static final java.lang.String STRUCTURE

LINEAR

public static final java.lang.String LINEAR

CUBIC

public static final java.lang.String CUBIC

SIDES

public static final java.lang.String SIDES

BACKFACETOLERANCE

public static final java.lang.String BACKFACETOLERANCE

STATISTICS

public static final java.lang.String STATISTICS

ENDOFFRAME

public static final java.lang.String ENDOFFRAME

LIMITS

public static final java.lang.String LIMITS

EYESPLITS

public static final java.lang.String EYESPLITS

DISPLACEMENTBOUND

public static final java.lang.String DISPLACEMENTBOUND

COORDINATESYSTEM

public static final java.lang.String COORDINATESYSTEM

SPHERE

public static final java.lang.String SPHERE

TRANSFORM

public static final java.lang.String TRANSFORM

JITTER

public static final java.lang.String JITTER

DEPTHFILTER

public static final java.lang.String DEPTHFILTER

MIN

public static final java.lang.String MIN

MAX

public static final java.lang.String MAX

AVERAGE

public static final java.lang.String AVERAGE

MIDPOINT

public static final java.lang.String MIDPOINT

CATMULLCLARK

public static final java.lang.String CATMULLCLARK

CREASE

public static final java.lang.String CREASE

CORNER

public static final java.lang.String CORNER

INTERPOLATEBOUNDARY

public static final java.lang.String INTERPOLATEBOUNDARY

HOLE

public static final java.lang.String HOLE

SEARCHPATH

public static final java.lang.String SEARCHPATH

SHADER

public static final java.lang.String SHADER

TEXTURE

public static final java.lang.String TEXTURE

DISPLAY

public static final java.lang.String DISPLAY

ARCHIVE

public static final java.lang.String ARCHIVE

HERMITESTEP

public static final int HERMITESTEP

CATMULLROMSTEP

public static final int CATMULLROMSTEP

BEZIERSTEP

public static final int BEZIERSTEP

BSPLINESTEP

public static final int BSPLINESTEP

POWERSTEP

public static final int POWERSTEP

hermiteBasis

public static final Matrix hermiteBasis

catmullRomBasis

public static final Matrix catmullRomBasis

bezierBasis

public static final Matrix bezierBasis

bSplineBasis

public static final Matrix bSplineBasis

powerBasis

public static final Matrix powerBasis

boxFilter

public static final FilterFunction boxFilter

triangleFilter

public static final FilterFunction triangleFilter

catmullRomFilter

public static final FilterFunction catmullRomFilter

gaussianFilter

public static final FilterFunction gaussianFilter

sincFilter

public static final FilterFunction sincFilter

FALSE

public static final boolean FALSE

TRUE

public static final boolean TRUE

INFINITY

public static final double INFINITY

EPSILON

public static final double EPSILON

errorIgnore

public static final ErrorHandler errorIgnore

errorPrint

public static final ErrorHandler errorPrint

errorAbort

public static final ErrorHandler errorAbort

procDelayedReadArchive

public static final RefineFunction procDelayedReadArchive

procRunProgram

public static final RefineFunction procRunProgram

procDynamicLoad

public static final RefineFunction procDynamicLoad

Method Detail

archiveRecord

public void archiveRecord(java.lang.String type,
                          java.lang.String s)
                   throws RMException

areaLightSource

public LightHandle areaLightSource(java.lang.String name,
                                   java.util.Map params)
                            throws RMException

atmosphere

public void atmosphere(java.lang.String name,
                       java.util.Map params)
                throws RMException

attribute

public void attribute(java.lang.String name,
                      java.util.Map params)
               throws RMException

attributeBegin

public void attributeBegin()
                    throws RMException

attributeEnd

public void attributeEnd()
                  throws RMException

basis

public void basis(Matrix ubasis,
                  int ustep,
                  Matrix vbasis,
                  int vstep)
           throws RMException

begin

public void begin()
           throws RMException

bound

public void bound(Bound bound)
           throws RMException

clipping

public void clipping(double near,
                     double far)
              throws RMException

color

public void color(Color c)
           throws RMException

colorSamples

public void colorSamples(int n,
                         double[] nRGB,
                         double[] RGBn)
                  throws RMException

concatTransform

public void concatTransform(Matrix transform)
                     throws RMException

cone

public void cone(double height,
                 double radius,
                 double thetamax,
                 java.util.Map params)
          throws RMException

coordSysTransform

public void coordSysTransform(java.lang.String coordinatesystem)
                       throws RMException

coordinateSystem

public void coordinateSystem(java.lang.String space)
                      throws RMException

cropWindow

public void cropWindow(double xmin,
                       double xmax,
                       double ymin,
                       double ymax)
                throws RMException

curves

public void curves(java.lang.String type,
                   int ncurves,
                   int[] nvertices,
                   java.lang.String wrap,
                   java.util.Map params)
            throws RMException

cylinder

public void cylinder(double radius,
                     double zmin,
                     double zmax,
                     double thetamax,
                     java.util.Map params)
              throws RMException

declare

public java.lang.String declare(java.lang.String name,
                                java.lang.String declaration)
                         throws RMException

deformation

public void deformation(java.lang.String name,
                        java.util.Map params)
                 throws RMException

depthOfField

public void depthOfField(double fstop,
                         double focallength,