RenderProps (Artisynth API documentation)

java.lang.Object
- maspack.render.RenderProps

All Implemented Interfaces:

java.lang.Cloneable, CompositeProperty, HasProperties, Clonable, Scannable

Direct Known Subclasses:

FaceRenderProps, LineEdgeRenderProps, LineFaceRenderProps, LineRenderProps, MeshRenderProps, PointEdgeRenderProps, PointFaceRenderProps, PointLineRenderProps, PointRenderProps
```
public class RenderProps
extends java.lang.Object
implements CompositeProperty, Scannable, Clonable
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RenderProps.Props

Nested Classes
Modifier and Type	Class and Description
`static class`	`RenderProps.Props`

Field Summary

Fields
Modifier and Type Field and Description

static PropertyList myProps

Fields
Modifier and Type	Field and Description
`static PropertyList`	`myProps`

Constructor Summary

Constructors
Constructor and Description

RenderProps()

RenderProps(RenderProps props)

Constructors
Constructor and Description
`RenderProps()`
`RenderProps(RenderProps props)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RenderProps`	`clone()` Returns a clone of this composite property.
`RenderProps`	`copy()`
`static RenderProps`	`createAndInitRenderProps(HasRenderProps host, RenderProps props)` Creates a set of render properties and initializes for use with the specified host
`static RenderProps`	`createFaceProps(HasProperties host)` Creates a new FaceRenderProps.
`static RenderProps`	`createLineEdgeProps(HasProperties host)` Creates a new LineEdgeRenderProps.
`static RenderProps`	`createLineFaceProps(HasProperties host)` Creates a new LineFaceRenderProps.
`static RenderProps`	`createLineProps(HasProperties host)` Creates a new LineRenderProps.
`static RenderProps`	`createMeshProps(HasProperties host)` Creates a new MeshRenderProps.
`static RenderProps`	`createPointFaceProps(HasProperties host)` Creates a new PointFaceRenderProps.
`static RenderProps`	`createPointLineProps(HasProperties host)` Creates a new PointLineRenderProps.
`static RenderProps`	`createPointProps(HasProperties host)` Creates a new PointRenderProps.
`static RenderProps`	`createRenderProps(HasProperties host)` Creates a new RenderProps.
`boolean`	`equals(java.lang.Object obj)`
`boolean`	`equals(RenderProps r)`
`static boolean`	`equals(RenderProps r1, RenderProps r2)`
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`double`	`getAlpha()`
`PropertyMode`	`getAlphaMode()`
`java.awt.Color`	`getBackColor()`
`float[]`	`getBackColor(float[] rgb)` Returns the RGB values for the back color as a float array, or `null` if no back color is set.
`float[]`	`getBackColorF()` Returns the internal float array used to store the back color RGB values.
`PropertyMode`	`getBackColorMode()`
`BumpMapProps`	`getBumpMap()`
`ColorMapProps`	`getColorMap()`
`boolean`	`getDrawEdges()`
`PropertyMode`	`getDrawEdgesMode()`
`java.awt.Color`	`getEdgeColor()`
`float[]`	`getEdgeColor(float[] rgb)` Returns the RGB values for the edge color as a float array, or `null` if no edge color is set.
`float[]`	`getEdgeColorF()` Returns the internal float array used to store the edge color RGB values.
`PropertyMode`	`getEdgeColorMode()`
`float[]`	`getEdgeOrLineColorF()`
`int`	`getEdgeWidth()`
`PropertyMode`	`getEdgeWidthMode()`
`java.awt.Color`	`getFaceColor()`
`float[]`	`getFaceColor(float[] rgb)` Returns the RGB values for the face color as a float array.
`float[]`	`getFaceColorF()` Returns the internal float array used to store the face color RGB values.
`PropertyMode`	`getFaceColorMode()`
`Renderer.FaceStyle`	`getFaceStyle()`
`PropertyMode`	`getFaceStyleMode()`
`java.awt.Color`	`getLineColor()`
`float[]`	`getLineColor(float[] rgb)` Returns the RGB values for the line color as a float array.
`float[]`	`getLineColorF()` Returns the internal float array used to store the line color RGB values.
`PropertyMode`	`getLineColorMode()`
`double`	`getLineRadius()`
`PropertyMode`	`getLineRadiusMode()`
`Renderer.LineStyle`	`getLineStyle()`
`PropertyMode`	`getLineStyleMode()`
`int`	`getLineWidth()`
`PropertyMode`	`getLineWidthMode()`
`NormalMapProps`	`getNormalMap()`
`java.awt.Color`	`getPointColor()`
`float[]`	`getPointColor(float[] rgb)` Returns the RGB values for the face color as a float array.
`float[]`	`getPointColorF()` Returns the internal float array used to store the point color RGB values.
`PropertyMode`	`getPointColorMode()`
`double`	`getPointRadius()`
`PropertyMode`	`getPointRadiusMode()`
`int`	`getPointSize()`
`PropertyMode`	`getPointSizeMode()`
`Renderer.PointStyle`	`getPointStyle()`
`PropertyMode`	`getPointStyleMode()`
`Property`	`getProperty(java.lang.String name)` Returns a property associated with a specified path name.
`HasProperties`	`getPropertyHost()` Returns the host for this property
`PropertyInfo`	`getPropertyInfo()` If this object is a property, returns the corresponding information
`Renderer.Shading`	`getShading()`
`PropertyMode`	`getShadingMode()`
`float`	`getShininess()`
`PropertyMode`	`getShininessMode()`
`java.awt.Color`	`getSpecular()`
`float[]`	`getSpecular(float[] rgb)` Returns the RGB values for the specular color as a float array, or `null` if no specular color is set.
`float[]`	`getSpecularF()` Returns the internal float array used to store the specular RGB values.
`PropertyMode`	`getSpecularMode()`
`PropertyMode`	`getVisibleMode()`
`int`	`getZOrder()`
`PropertyMode`	`getZOrderMode()`
`boolean`	`isTransparent()`
`boolean`	`isVisible()`
`boolean`	`isWritable()` Returns `true` if this component should in fact be written to secondary storage.
`void`	`scaleDistance(double s)` Scales the properties that are associated with distance.
`void`	`scan(ReaderTokenizer rtok, java.lang.Object ref)` Scans this element from a ReaderTokenizer.
`void`	`set(RenderProps r)`
`void`	`setAlpha(double a)`
`static void`	`setAlpha(Renderable r, double alpha)`
`void`	`setAlphaMode(PropertyMode mode)`
`static void`	`setAlphaMode(Renderable r, PropertyMode mode)`
`void`	`setBackColor(java.awt.Color color)`
`void`	`setBackColor(float[] rgb)`
`static void`	`setBackColor(Renderable r, java.awt.Color color)`
`static void`	`setBackColor(Renderable r, float[] rgb)`
`void`	`setBackColorMode(PropertyMode mode)`
`static void`	`setBackColorMode(Renderable r, PropertyMode mode)`
`void`	`setBumpMap(BumpMapProps props)`
`static void`	`setBumpMap(Renderable r, BumpMapProps bprops)`
`static void`	`setBumpMapEnabled(Renderable r, boolean enabled)`
`static void`	`setBumpMapEnabledMode(Renderable r, PropertyMode mode)`
`static void`	`setBumpMapFileName(Renderable r, java.lang.String fileName)`
`static void`	`setBumpMapFileNameMode(Renderable r, PropertyMode mode)`
`void`	`setColorMap(ColorMapProps props)`
`static void`	`setColorMap(Renderable r, ColorMapProps tprops)`
`static void`	`setColorMapEnabled(Renderable r, boolean enabled)`
`static void`	`setColorMapEnabledMode(Renderable r, PropertyMode mode)`
`static void`	`setColorMapFileName(Renderable r, java.lang.String fileName)`
`static void`	`setColorMapFileNameMode(Renderable r, PropertyMode mode)`
`static void`	`setCubePoints(Renderable r, double width, java.awt.Color color)`
`static void`	`setCylindricalLines(Renderable r, double rad, java.awt.Color color)`
`void`	`setDrawEdges(boolean enable)`
`static void`	`setDrawEdges(Renderable r, boolean drawEdges)`
`void`	`setDrawEdgesMode(PropertyMode mode)`
`static void`	`setDrawEdgesMode(Renderable r, PropertyMode mode)`
`void`	`setEdgeColor(java.awt.Color color)`
`void`	`setEdgeColor(float[] rgb)`
`static void`	`setEdgeColor(Renderable r, java.awt.Color color)`
`static void`	`setEdgeColor(Renderable r, float[] rgb)`
`void`	`setEdgeColorMode(PropertyMode mode)`
`static void`	`setEdgeColorMode(Renderable r, PropertyMode mode)`
`void`	`setEdgeWidth(int width)`
`static void`	`setEdgeWidth(Renderable r, int width)`
`void`	`setEdgeWidthMode(PropertyMode mode)`
`static void`	`setEdgeWidthMode(Renderable r, PropertyMode mode)`
`void`	`setFaceColor(java.awt.Color color)`
`void`	`setFaceColor(float[] rgb)`
`static void`	`setFaceColor(Renderable r, java.awt.Color color)`
`static void`	`setFaceColor(Renderable r, float[] rgb)`
`void`	`setFaceColorMode(PropertyMode mode)`
`static void`	`setFaceColorMode(Renderable r, PropertyMode mode)`
`static void`	`setFaceStyle(Renderable r, Renderer.FaceStyle style)`
`void`	`setFaceStyle(Renderer.FaceStyle mode)`
`void`	`setFaceStyleMode(PropertyMode mode)`
`static void`	`setFaceStyleMode(Renderable r, PropertyMode mode)`
`void`	`setLineColor(java.awt.Color color)`
`void`	`setLineColor(float[] rgb)`
`static void`	`setLineColor(Renderable r, java.awt.Color color)`
`static void`	`setLineColor(Renderable r, float[] rgb)`
`void`	`setLineColorMode(PropertyMode mode)`
`static void`	`setLineColorMode(Renderable r, PropertyMode mode)`
`void`	`setLineRadius(double r)`
`static void`	`setLineRadius(Renderable r, double radius)`
`void`	`setLineRadiusMode(PropertyMode mode)`
`static void`	`setLineRadiusMode(Renderable r, PropertyMode mode)`
`static void`	`setLineStyle(Renderable r, Renderer.LineStyle style)`
`void`	`setLineStyle(Renderer.LineStyle style)`
`void`	`setLineStyleMode(PropertyMode mode)`
`static void`	`setLineStyleMode(Renderable r, PropertyMode mode)`
`void`	`setLineWidth(int width)`
`static void`	`setLineWidth(Renderable r, int width)`
`void`	`setLineWidthMode(PropertyMode mode)`
`static void`	`setLineWidthMode(Renderable r, PropertyMode mode)`
`void`	`setNormalMap(NormalMapProps props)`
`static void`	`setNormalMap(Renderable r, NormalMapProps nprops)`
`static void`	`setNormalMapEnabled(Renderable r, boolean enabled)`
`static void`	`setNormalMapEnabledMode(Renderable r, PropertyMode mode)`
`static void`	`setNormalMapFileName(Renderable r, java.lang.String fileName)`
`static void`	`setNormalMapFileNameMode(Renderable r, PropertyMode mode)`
`void`	`setPointColor(java.awt.Color color)`
`void`	`setPointColor(float[] rgb)`
`static void`	`setPointColor(Renderable r, java.awt.Color color)`
`static void`	`setPointColor(Renderable r, float[] rgb)`
`void`	`setPointColorMode(PropertyMode mode)`
`static void`	`setPointColorMode(Renderable r, PropertyMode mode)`
`void`	`setPointRadius(double r)`
`static void`	`setPointRadius(Renderable r, double radius)`
`void`	`setPointRadiusMode(PropertyMode mode)`
`static void`	`setPointRadiusMode(Renderable r, PropertyMode mode)`
`void`	`setPointSize(int size)`
`static void`	`setPointSize(Renderable r, int size)`
`void`	`setPointSizeMode(PropertyMode mode)`
`static void`	`setPointSizeMode(Renderable r, PropertyMode mode)`
`static void`	`setPointStyle(Renderable r, Renderer.PointStyle style)`
`void`	`setPointStyle(Renderer.PointStyle style)`
`void`	`setPointStyleMode(PropertyMode mode)`
`static void`	`setPointStyleMode(Renderable r, PropertyMode mode)`
`void`	`setPropertyHost(HasProperties newParent)` Sets the host for this property.
`void`	`setPropertyInfo(PropertyInfo info)` Sets the property information for this property.
`static void`	`setShading(Renderable r, Renderer.Shading shading)`
`void`	`setShading(Renderer.Shading shading)`
`void`	`setShadingMode(PropertyMode mode)`
`static void`	`setShadingMode(Renderable r, PropertyMode mode)`
`void`	`setShininess(float s)`
`static void`	`setShininess(Renderable r, double shininess)`
`void`	`setShininessMode(PropertyMode mode)`
`static void`	`setShininessMode(Renderable r, PropertyMode mode)`
`static void`	`setSolidArrowLines(Renderable r, double rad, java.awt.Color color)`
`void`	`setSpecular(java.awt.Color color)`
`void`	`setSpecular(float[] rgb)`
`static void`	`setSpecular(Renderable r, java.awt.Color color)`
`static void`	`setSpecular(Renderable r, float[] rgb)`
`void`	`setSpecularMode(PropertyMode mode)`
`static void`	`setSpecularMode(Renderable r, PropertyMode mode)`
`static void`	`setSphericalPoints(Renderable r, double rad, java.awt.Color color)`
`static void`	`setSpindleLines(Renderable r, double rad, java.awt.Color color)`
`static void`	`setTextureEnabled(Renderable r, boolean enabled)` Enable or disable all texture-based properties, such as color-map, bump-map, and normal-map
`void`	`setVisible(boolean visible)`
`static void`	`setVisible(Renderable r, boolean visible)`
`void`	`setVisibleMode(PropertyMode mode)`
`static void`	`setVisibleMode(Renderable r, PropertyMode mode)`
`static void`	`setWireFrame(Renderable r, boolean enable)` Sets the render properties for a renderable to be consistent with either wireframe or solid face rendering.
`static void`	`setWireFrame(Renderable r, boolean enable, Renderer.Shading shading)` Sets the render properties for a renderable to be consistent with either wireframe or solid face rendering.
`void`	`setZOrder(int order)`
`static void`	`setZOrder(Renderable r, int order)`
`void`	`setZOrderMode(PropertyMode mode)`
`static void`	`setZOrderMode(Renderable r, PropertyMode mode)`
`java.lang.String`	`toString()`
`void`	`write(java.io.PrintWriter pw, NumberFormat fmt, java.lang.Object ref)` Writes a text description of this element to a PrintWriter.

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- myProps
```
public static PropertyList myProps
```

Constructor Detail

RenderProps
```
public RenderProps()
```

RenderProps
```
public RenderProps(RenderProps props)
```

Method Detail

getPropertyInfo
```
public PropertyInfo getPropertyInfo()
```
Description copied from interface: CompositeProperty

If this object is a property, returns the corresponding information

Specified by:

getPropertyInfo in interface CompositeProperty

Returns:

property information for this object

setPropertyInfo
```
public void setPropertyInfo(PropertyInfo info)
```
Description copied from interface: CompositeProperty

Sets the property information for this property.

Specified by:

setPropertyInfo in interface CompositeProperty

Parameters:

info - property information

getPropertyHost
```
public HasProperties getPropertyHost()
```
Description copied from interface: CompositeProperty

Returns the host for this property

Specified by:

getPropertyHost in interface CompositeProperty

Returns:

host for this property

setPropertyHost
```
public void setPropertyHost(HasProperties newParent)
```
Description copied from interface: CompositeProperty

Sets the host for this property.

Specified by:

setPropertyHost in interface CompositeProperty

Parameters:

newParent - host for this property

isVisible
```
public boolean isVisible()
```

setVisible

public void setVisible(boolean visible)

getVisibleMode
```
public PropertyMode getVisibleMode()
```

setVisibleMode

public void setVisibleMode(PropertyMode mode)

getLineWidth
```
public int getLineWidth()
```

setLineWidth
```
public void setLineWidth(int width)
```

getLineWidthMode

public PropertyMode getLineWidthMode()

setLineWidthMode

public void setLineWidthMode(PropertyMode mode)

getPointSize
```
public int getPointSize()
```

setPointSize
```
public void setPointSize(int size)
```

getPointSizeMode

public PropertyMode getPointSizeMode()

setPointSizeMode

public void setPointSizeMode(PropertyMode mode)

getFaceColor
```
public java.awt.Color getFaceColor()
```

getFaceColorF
```
public float[] getFaceColorF()
```
Returns the internal float array used to store the face color RGB values.

Returns:

internal face color array. Should not be modified.

setFaceColor

public void setFaceColor(float[] rgb)

setFaceColor

public void setFaceColor(java.awt.Color color)

getFaceColor
```
public float[] getFaceColor(float[] rgb)
```
Returns the RGB values for the face color as a float array. The application may supply the array via the argument rgb. Otherwise, if rgb is null, an array will be allocated.

Parameters:

rgb - optional storage for returning the RGB values

Returns:

RGB values for the face color

getFaceColorMode

public PropertyMode getFaceColorMode()

setFaceColorMode

public void setFaceColorMode(PropertyMode mode)

getAlpha
```
public double getAlpha()
```

setAlpha
```
public void setAlpha(double a)
```

getAlphaMode
```
public PropertyMode getAlphaMode()
```

setAlphaMode

public void setAlphaMode(PropertyMode mode)

getZOrder
```
public int getZOrder()
```

setZOrder
```
public void setZOrder(int order)
```

getZOrderMode
```
public PropertyMode getZOrderMode()
```

setZOrderMode

public void setZOrderMode(PropertyMode mode)

isTransparent
```
public boolean isTransparent()
```

getShading
```
public Renderer.Shading getShading()
```

setShading

public void setShading(Renderer.Shading shading)

getShadingMode
```
public PropertyMode getShadingMode()
```

setShadingMode

public void setShadingMode(PropertyMode mode)

getShininess
```
public float getShininess()
```

setShininess
```
public void setShininess(float s)
```

getShininessMode

public PropertyMode getShininessMode()

setShininessMode

public void setShininessMode(PropertyMode mode)

getSpecular
```
public java.awt.Color getSpecular()
```

getSpecularF
```
public float[] getSpecularF()
```
Returns the internal float array used to store the specular RGB values. This will be null if the specular color is not set.

Returns:

internal specular color array. Should not be modified.

setSpecular
```
public void setSpecular(float[] rgb)
```

setSpecular

public void setSpecular(java.awt.Color color)

getSpecular
```
public float[] getSpecular(float[] rgb)
```
Returns the RGB values for the specular color as a float array, or null if no specular color is set. The application may supply the array via the argument rgb. Otherwise, if rgb is null and the specular color is not null, an array will be allocated.

Parameters:

rgb - optional storage for returning the RGB values

Returns:

RGB values for the specular color, or null if no specular color is set

getSpecularMode
```
public PropertyMode getSpecularMode()
```

setSpecularMode

public void setSpecularMode(PropertyMode mode)

getPointStyle

public Renderer.PointStyle getPointStyle()

setPointStyle

public void setPointStyle(Renderer.PointStyle style)

getPointStyleMode

public PropertyMode getPointStyleMode()

setPointStyleMode

public void setPointStyleMode(PropertyMode mode)

getPointRadius
```
public double getPointRadius()
```

setPointRadius
```
public void setPointRadius(double r)
```

getPointRadiusMode

public PropertyMode getPointRadiusMode()

setPointRadiusMode

public void setPointRadiusMode(PropertyMode mode)

getLineStyle

public Renderer.LineStyle getLineStyle()

setLineStyle

public void setLineStyle(Renderer.LineStyle style)

getLineStyleMode

public PropertyMode getLineStyleMode()

setLineStyleMode

public void setLineStyleMode(PropertyMode mode)

getLineRadius
```
public double getLineRadius()
```

setLineRadius
```
public void setLineRadius(double r)
```

getLineRadiusMode

public PropertyMode getLineRadiusMode()

setLineRadiusMode

public void setLineRadiusMode(PropertyMode mode)

getDrawEdges
```
public boolean getDrawEdges()
```

setDrawEdges

public void setDrawEdges(boolean enable)

getDrawEdgesMode

public PropertyMode getDrawEdgesMode()

setDrawEdgesMode

public void setDrawEdgesMode(PropertyMode mode)

getEdgeWidth
```
public int getEdgeWidth()
```

setEdgeWidth
```
public void setEdgeWidth(int width)
```

getEdgeWidthMode

public PropertyMode getEdgeWidthMode()

setEdgeWidthMode

public void setEdgeWidthMode(PropertyMode mode)

getEdgeColor
```
public java.awt.Color getEdgeColor()
```

getEdgeOrLineColorF
```
public float[] getEdgeOrLineColorF()
```

getEdgeColorF
```
public float[] getEdgeColorF()
```
Returns the internal float array used to store the edge color RGB values. This will be null if the edge color is not set.

Returns:

internal edge color array. Should not be modified.

setEdgeColor

public void setEdgeColor(float[] rgb)

setEdgeColor

public void setEdgeColor(java.awt.Color color)

getEdgeColor
```
public float[] getEdgeColor(float[] rgb)
```
Returns the RGB values for the edge color as a float array, or null if no edge color is set. The application may supply the array via the argument rgb. Otherwise, if rgb is null and the edge color is not null, an array will be allocated.

Parameters:

rgb - optional storage for returning the RGB values

Returns:

RGB values for the edge color, or null if no edge color is set

getEdgeColorMode

public PropertyMode getEdgeColorMode()

setEdgeColorMode

public void setEdgeColorMode(PropertyMode mode)

getFaceStyle

public Renderer.FaceStyle getFaceStyle()

setFaceStyle

public void setFaceStyle(Renderer.FaceStyle mode)

getFaceStyleMode

public PropertyMode getFaceStyleMode()

setFaceStyleMode

public void setFaceStyleMode(PropertyMode mode)

getBackColor
```
public java.awt.Color getBackColor()
```

getBackColorF
```
public float[] getBackColorF()
```
Returns the internal float array used to store the back color RGB values. This will be null if the back color is not set.

Returns:

internal back color array. Should not be modified.

setBackColor

public void setBackColor(float[] rgb)

setBackColor

public void setBackColor(java.awt.Color color)

getBackColor
```
public float[] getBackColor(float[] rgb)
```
Returns the RGB values for the back color as a float array, or null if no back color is set. The application may supply the array via the argument rgb. Otherwise, if rgb is null and the back color is not null, an array will be allocated.

Parameters:

rgb - optional storage for returning the RGB values

Returns:

RGB values for the back color, or null if no back color is set

getBackColorMode

public PropertyMode getBackColorMode()

setBackColorMode

public void setBackColorMode(PropertyMode mode)

getLineColor
```
public java.awt.Color getLineColor()
```

getLineColorF
```
public float[] getLineColorF()
```
Returns the internal float array used to store the line color RGB values.

Returns:

internal line color array. Should not be modified.

setLineColor

public void setLineColor(float[] rgb)

setLineColor

public void setLineColor(java.awt.Color color)

getLineColor
```
public float[] getLineColor(float[] rgb)
```
Returns the RGB values for the line color as a float array. The application may supply the array via the argument rgb. Otherwise, if rgb is null, an array will be allocated.

Parameters:

rgb - optional storage for returning the RGB values

Returns:

RGB values for the line color

getLineColorMode

public PropertyMode getLineColorMode()

setLineColorMode

public void setLineColorMode(PropertyMode mode)

getPointColor
```
public java.awt.Color getPointColor()
```

getPointColorF
```
public float[] getPointColorF()
```
Returns the internal float array used to store the point color RGB values.

Returns:

internal point color array. Should not be modified.

setPointColor

public void setPointColor(float[] rgb)

getPointColor
```
public float[] getPointColor(float[] rgb)
```
Returns the RGB values for the face color as a float array. The application may supply the array via the argument rgb. Otherwise, if rgb is null, an array will be allocated.

Parameters:

rgb - optional storage for returning the RGB values

Returns:

RGB values for the face color

setPointColor

public void setPointColor(java.awt.Color color)

getPointColorMode

public PropertyMode getPointColorMode()

setPointColorMode

public void setPointColorMode(PropertyMode mode)

getColorMap
```
public ColorMapProps getColorMap()
```

setColorMap

public void setColorMap(ColorMapProps props)

getNormalMap
```
public NormalMapProps getNormalMap()
```

setNormalMap

public void setNormalMap(NormalMapProps props)

getBumpMap
```
public BumpMapProps getBumpMap()
```

setBumpMap

public void setBumpMap(BumpMapProps props)

getProperty
```
public Property getProperty(java.lang.String name)
```
Description copied from interface: HasProperties

Returns a property associated with a specified path name. All properties exported by this object must have a name which is a valid Java identifier. Specifying one of these names causes the corresponding Property to be returned. Handles to subproperties can also be obtained by delimiting the sub-property name(s) by '.' characters. A sub-property exists if the value of a property is itself an object which exports properties. It is only possible to obtain a sub-property handle if each of its ancestor properties exports their values by reference.

Specified by:

getProperty in interface HasProperties

Parameters:

name - name of the desired property or sub-property

Returns:

handle to the property

getAllPropertyInfo
```
public PropertyList getAllPropertyInfo()
```
Description copied from interface: HasProperties

Returns a list giving static information about all properties exported by this object.

Specified by:

getAllPropertyInfo in interface HasProperties

Returns:

static information for all exported properties

set
```
public void set(RenderProps r)
```

equals
```
public boolean equals(RenderProps r)
```

equals

public static boolean equals(RenderProps r1,
                             RenderProps r2)

equals

public boolean equals(java.lang.Object obj)

Overrides:: equals in class java.lang.Object

isWritable
```
public boolean isWritable()
```
Description copied from interface: Scannable

Returns true if this component should in fact be written to secondary storage. This gives subclasses control over whether or not they are actually written out.

Specified by:

isWritable in interface Scannable

Returns:

true if this component should be written to secondary storage.

write
```
public void write(java.io.PrintWriter pw,
                  NumberFormat fmt,
                  java.lang.Object ref)
           throws java.io.IOException
```
Description copied from interface: Scannable

Writes a text description of this element to a PrintWriter. The text description should be compatable with scan and complete enough to allow full reconstruction of the element.

Specified by:

write in interface Scannable

Parameters:

pw - stream for writing the element

fmt - numeric formating information

ref - optional reference object which can be used for producing references to other objects

Throws:

java.io.IOException - if an I/O error occured

scan
```
public void scan(ReaderTokenizer rtok,
                 java.lang.Object ref)
          throws java.io.IOException
```
Description copied from interface: Scannable

Scans this element from a ReaderTokenizer. The expected text format is assumed to be compatible with that produced by write.

Specified by:

scan in interface Scannable

Parameters:

rtok - Tokenizer from which to scan the element

ref - optional reference object which can be used for resolving references to other objects

Throws:

java.io.IOException - if an I/O or formatting error occured

createRenderProps
```
public static RenderProps createRenderProps(HasProperties host)
```
Creates a new RenderProps. If the supplied host is non-null, then it is used to initialize any inherited properties. The property name associated with the host is assumed to be "renderProps".

Parameters:

host - if non-null, is used to initialize inherited values

Returns:

render properties appropriate for lines

createLineProps
```
public static RenderProps createLineProps(HasProperties host)
```
Creates a new LineRenderProps. If the supplied host is non-null, then it is used to initialize any inherited properties. The property name associated with the host is assumed to be "renderProps".

Parameters:

host - if non-null, is used to initialize inherited values

Returns:

render properties appropriate for lines

createLineFaceProps
```
public static RenderProps createLineFaceProps(HasProperties host)
```
Creates a new LineFaceRenderProps. If the supplied host is non-null, then it is used to initialize any inherited properties. The property name associated with the host is assumed to be "renderProps".

Parameters:

host - if non-null, is used to initialize inherited values

Returns:

render properties appropriate for lines

createLineEdgeProps
```
public static RenderProps createLineEdgeProps(HasProperties host)
```
Creates a new LineEdgeRenderProps. If the supplied host is non-null, then it is used to initialize any inherited properties. The property name associated with the host is assumed to be "renderProps".

Parameters:

host - if non-null, is used to initialize inherited values

Returns:

render properties appropriate for lines

createPointLineProps
```
public static RenderProps createPointLineProps(HasProperties host)
```
Creates a new PointLineRenderProps. If the supplied host is non-null, then it is used to initialize any inherited properties. The property name associated with the host is assumed to be "renderProps".

Parameters:

host - if non-null, is used to initialize inherited values

Returns:

render properties appropriate for lines

createPointFaceProps
```
public static RenderProps createPointFaceProps(HasProperties host)
```
Creates a new PointFaceRenderProps. If the supplied host is non-null, then it is used to initialize any inherited properties. The property name associated with the host is assumed to be "renderProps".

Parameters:

host - if non-null, is used to initialize inherited values

Returns:

render properties appropriate for lines

createPointProps
```
public static RenderProps createPointProps(HasProperties host)
```
Creates a new PointRenderProps. If the supplied host is non-null, then it is used to initialize any inherited properties. The property name associated with the host is assumed to be "renderProps".

Parameters:

host - if non-null, is used to initialize inherited values

Returns:

render properties appropriate for lines

createMeshProps
```
public static RenderProps createMeshProps(HasProperties host)
```
Creates a new MeshRenderProps. If the supplied host is non-null, then it is used to initialize any inherited properties. The property name associated with the host is assumed to be "renderProps".

Parameters:

host - if non-null, is used to initialize inherited values

Returns:

render properties appropriate for lines

createFaceProps
```
public static RenderProps createFaceProps(HasProperties host)
```
Creates a new FaceRenderProps. If the supplied host is non-null, then it is used to initialize any inherited properties. The property name associated with the host is assumed to be "renderProps".

Parameters:

host - if non-null, is used to initialize inherited values

Returns:

render properties appropriate for lines

scaleDistance
```
public void scaleDistance(double s)
```
Scales the properties that are associated with distance. This includes the sphere radius and cylinder radius.

Parameters:

s - scale factor

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

copy
```
public RenderProps copy()
```

clone
```
public RenderProps clone()
```
Description copied from interface: CompositeProperty

Returns a clone of this composite property.

Specified by:

clone in interface CompositeProperty

Specified by:

clone in interface Clonable

Overrides:

clone in class java.lang.Object

Returns:

clone of this property

setVisible

public static void setVisible(Renderable r,
                              boolean visible)

setVisibleMode

public static void setVisibleMode(Renderable r,
                                  PropertyMode mode)

setShading

public static void setShading(Renderable r,
                              Renderer.Shading shading)

setShadingMode

public static void setShadingMode(Renderable r,
                                  PropertyMode mode)

setAlpha

public static void setAlpha(Renderable r,
                            double alpha)

setAlphaMode

public static void setAlphaMode(Renderable r,
                                PropertyMode mode)

setZOrder

public static void setZOrder(Renderable r,
                             int order)

setZOrderMode

public static void setZOrderMode(Renderable r,
                                 PropertyMode mode)

setShininess

public static void setShininess(Renderable r,
                                double shininess)

setShininessMode

public static void setShininessMode(Renderable r,
                                    PropertyMode mode)

setSpecular

public static void setSpecular(Renderable r,
                               java.awt.Color color)

setSpecular

public static void setSpecular(Renderable r,
                               float[] rgb)

setSpecularMode

public static void setSpecularMode(Renderable r,
                                   PropertyMode mode)

setFaceStyle

public static void setFaceStyle(Renderable r,
                                Renderer.FaceStyle style)

setFaceStyleMode

public static void setFaceStyleMode(Renderable r,
                                    PropertyMode mode)

setFaceColor

public static void setFaceColor(Renderable r,
                                java.awt.Color color)

setFaceColor

public static void setFaceColor(Renderable r,
                                float[] rgb)

setFaceColorMode

public static void setFaceColorMode(Renderable r,
                                    PropertyMode mode)

setBackColor

public static void setBackColor(Renderable r,
                                java.awt.Color color)

setBackColor

public static void setBackColor(Renderable r,
                                float[] rgb)

setBackColorMode

public static void setBackColorMode(Renderable r,
                                    PropertyMode mode)

setDrawEdges

public static void setDrawEdges(Renderable r,
                                boolean drawEdges)

setDrawEdgesMode

public static void setDrawEdgesMode(Renderable r,
                                    PropertyMode mode)

setEdgeWidth

public static void setEdgeWidth(Renderable r,
                                int width)

setEdgeWidthMode

public static void setEdgeWidthMode(Renderable r,
                                    PropertyMode mode)

setEdgeColor

public static void setEdgeColor(Renderable r,
                                java.awt.Color color)

setEdgeColor

public static void setEdgeColor(Renderable r,
                                float[] rgb)

setEdgeColorMode

public static void setEdgeColorMode(Renderable r,
                                    PropertyMode mode)

setLineStyle

public static void setLineStyle(Renderable r,
                                Renderer.LineStyle style)

setLineStyleMode

public static void setLineStyleMode(Renderable r,
                                    PropertyMode mode)

setLineColor

public static void setLineColor(Renderable r,
                                java.awt.Color color)

setLineColor

public static void setLineColor(Renderable r,
                                float[] rgb)

setLineColorMode

public static void setLineColorMode(Renderable r,
                                    PropertyMode mode)

setLineWidth

public static void setLineWidth(Renderable r,
                                int width)

setLineWidthMode

public static void setLineWidthMode(Renderable r,
                                    PropertyMode mode)

setLineRadius

public static void setLineRadius(Renderable r,
                                 double radius)

setLineRadiusMode

public static void setLineRadiusMode(Renderable r,
                                     PropertyMode mode)

setPointStyle

public static void setPointStyle(Renderable r,
                                 Renderer.PointStyle style)

setPointStyleMode

public static void setPointStyleMode(Renderable r,
                                     PropertyMode mode)

setPointColor

public static void setPointColor(Renderable r,
                                 java.awt.Color color)

setPointColor

public static void setPointColor(Renderable r,
                                 float[] rgb)

setPointColorMode

public static void setPointColorMode(Renderable r,
                                     PropertyMode mode)

setPointSize

public static void setPointSize(Renderable r,
                                int size)

setPointSizeMode

public static void setPointSizeMode(Renderable r,
                                    PropertyMode mode)

setPointRadius

public static void setPointRadius(Renderable r,
                                  double radius)

setPointRadiusMode

public static void setPointRadiusMode(Renderable r,
                                      PropertyMode mode)

setCubePoints

public static void setCubePoints(Renderable r,
                                 double width,
                                 java.awt.Color color)

setSphericalPoints

public static void setSphericalPoints(Renderable r,
                                      double rad,
                                      java.awt.Color color)

setCylindricalLines

public static void setCylindricalLines(Renderable r,
                                       double rad,
                                       java.awt.Color color)

setSolidArrowLines

public static void setSolidArrowLines(Renderable r,
                                      double rad,
                                      java.awt.Color color)

setSpindleLines

public static void setSpindleLines(Renderable r,
                                   double rad,
                                   java.awt.Color color)

setWireFrame
```
public static void setWireFrame(Renderable r,
                                boolean enable)
```
Sets the render properties for a renderable to be consistent with either wireframe or solid face rendering. For wireframe rendering, the faces, drawEdges and shading properties are set to Faces.NONE, true, and Shading.NONE, respectively. For solid frame rendering, they are set to Faces.FRONT, false, and Shading.FLAT.

Parameters:

r - Renderable whose properties are to be set

enable - if true, enable wireframe rendering.

setWireFrame
```
public static void setWireFrame(Renderable r,
                                boolean enable,
                                Renderer.Shading shading)
```
Sets the render properties for a renderable to be consistent with either wireframe or solid face rendering. For wireframe rendering, the faces and drawEdges properties are set to Faces.NONE and true, respectively. For solid frame rendering, they are set to Faces.FRONT and false. The shading property is set to the value of the shading argument.

Parameters:

r - Renderable whose properties are to be set

enable - if true, enable wireframe rendering.

shading - new value for the shading property

setTextureEnabled

public static void setTextureEnabled(Renderable r,
                                     boolean enabled)

Enable or disable all texture-based properties, such as color-map, bump-map, and normal-map

setColorMap

public static void setColorMap(Renderable r,
                               ColorMapProps tprops)

setColorMapEnabled

public static void setColorMapEnabled(Renderable r,
                                      boolean enabled)

setColorMapEnabledMode

public static void setColorMapEnabledMode(Renderable r,
                                          PropertyMode mode)

setColorMapFileName

public static void setColorMapFileName(Renderable r,
                                       java.lang.String fileName)

setColorMapFileNameMode

public static void setColorMapFileNameMode(Renderable r,
                                           PropertyMode mode)

setNormalMap

public static void setNormalMap(Renderable r,
                                NormalMapProps nprops)

setNormalMapEnabled

public static void setNormalMapEnabled(Renderable r,
                                       boolean enabled)

setNormalMapEnabledMode

public static void setNormalMapEnabledMode(Renderable r,
                                           PropertyMode mode)

setNormalMapFileName

public static void setNormalMapFileName(Renderable r,
                                        java.lang.String fileName)

setNormalMapFileNameMode

public static void setNormalMapFileNameMode(Renderable r,
                                            PropertyMode mode)

setBumpMap

public static void setBumpMap(Renderable r,
                              BumpMapProps bprops)

setBumpMapEnabled

public static void setBumpMapEnabled(Renderable r,
                                     boolean enabled)

setBumpMapEnabledMode

public static void setBumpMapEnabledMode(Renderable r,
                                         PropertyMode mode)

setBumpMapFileName

public static void setBumpMapFileName(Renderable r,
                                      java.lang.String fileName)

setBumpMapFileNameMode

public static void setBumpMapFileNameMode(Renderable r,
                                          PropertyMode mode)

createAndInitRenderProps
```
public static RenderProps createAndInitRenderProps(HasRenderProps host,
                                                   RenderProps props)
```
Creates a set of render properties and initializes for use with the specified host

Parameters:

host - host object that has render properties

props - the properties to copy and assign

Returns:

the created render properties

Class RenderProps

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

myProps

Constructor Detail

RenderProps

RenderProps

Method Detail

getPropertyInfo

setPropertyInfo

getPropertyHost

setPropertyHost

isVisible

setVisible

getVisibleMode

setVisibleMode

getLineWidth

setLineWidth

getLineWidthMode

setLineWidthMode

getPointSize

setPointSize

getPointSizeMode

setPointSizeMode

getFaceColor

getFaceColorF

setFaceColor

setFaceColor

getFaceColor

getFaceColorMode

setFaceColorMode

getAlpha

setAlpha

getAlphaMode

setAlphaMode

getZOrder

setZOrder

getZOrderMode

setZOrderMode

isTransparent

getShading

setShading

getShadingMode

setShadingMode

getShininess

setShininess

getShininessMode

setShininessMode

getSpecular

getSpecularF

setSpecular

setSpecular

getSpecular

getSpecularMode

setSpecularMode

getPointStyle

setPointStyle

getPointStyleMode

setPointStyleMode

getPointRadius

setPointRadius

getPointRadiusMode

setPointRadiusMode

getLineStyle

setLineStyle

getLineStyleMode

setLineStyleMode

getLineRadius

setLineRadius

getLineRadiusMode

setLineRadiusMode

getDrawEdges

setDrawEdges

getDrawEdgesMode

setDrawEdgesMode

getEdgeWidth