Factory:org.bzdev.p3d.Model3DViewFactory
Parameter Types
(optional keytype)
(value type)
Range RV Mode Add/Set
backsideColor
Backside Color
(none) N/A false clear
The color to use for the backside of triangles (the side that is inside an object)
backsideColor.alpha
Alpha
java.lang.Integer [0, 255] false set
The alpha component of the color (0 for transparent to 255 for opaque)
backsideColor.blue
Blue
java.lang.Integer [0, 255] false set
The blue component of the color (0 for none to 255 for the maximum value)
backsideColor.css
CSS Color
java.lang.String N/A false set
The CSS specification for the color
This parameter's value provides a color via a string containing a CSS (Cascading Style Sheet) color (level 3). The specification for a CSS color, level 3, can be found in a W3C recommendation, and consists of one of the following:
  • 6 hexadecimal digits following an '#' and providing an opaque color (i.e., the alpha value is 255 in a RGBA color space).
  • rgb(RED,BLUE,GREEN), where RED, BLUE,, and GREEN are either numbers in the range [0, 255] or a number (typically floating point) followed by a '%'.
  • rgba(RED,BLUE,GREEN,ALPHA), where RED, BLUE, and GREEN are either numbers in the range [0, 255] or a number (typically floating point) followed by a '%', and ALPHA varies from 0.0 (fully transparent to 1.0 (opaque).
  • hsl(HUE,SATURATION,LIGHTNESS), where HUE is in the range [0,360], SATURATION is a number in the range [0,100] followed immediately by a '%', and where LIGHTNESS is a number in the range [0,100] followed immediately by a '%'.
  • hsl(HUE,SATURATION,LIGHTNESS, ALPHA), where HUE is in the range [0,360), SATURATION is a number in the range [0,100] followed immediately by a '%', where LIGHTNESS is a number in the range [0,100] followed immediately by a '%', and where ALPHA is a floating point number in the range [0, 1].
  • a keyword denoting an X11 color with the addition of "gray" and its synonym "grey" from SVG 1.0. X11 colors are described in the document X11 color names. The variant of these names that this class uses are the ones given in the W3C recommendation cited above. These are all lower case with no whitespace.
  • the value null, indicating that this parameter is not in use.
The subparameters red, green, blue, and alpha, when not null, will override the corresponding components of the CSS color. If the css, red, green, blue, and alpha parameters are all null, a default color (possibly null) will be used.
backsideColor.green
Green
java.lang.Integer [0, 255] false set
The green component of the color (0 for none to 255 for maximum value)
backsideColor.red
Red
java.lang.Integer [0, 255] false set
The red component of the color (0 for none to 255 for the maximum value)
backsideSegmentColor
Backside Segment Color
(none) N/A false clear
The color to use for the edges of subtriangles added for rendering when part of the backside of a triangle
backsideSegmentColor.alpha
Alpha
java.lang.Integer [0, 255] false set
The alpha component of the color (0 for transparent to 255 for opaque)
backsideSegmentColor.blue
Blue
java.lang.Integer [0, 255] false set
The blue component of the color (0 for none to 255 for the maximum value)
backsideSegmentColor.css
CSS Color
java.lang.String N/A false set
The CSS specification for the color
This parameter's value provides a color via a string containing a CSS (Cascading Style Sheet) color (level 3). The specification for a CSS color, level 3, can be found in a W3C recommendation, and consists of one of the following:
  • 6 hexadecimal digits following an '#' and providing an opaque color (i.e., the alpha value is 255 in a RGBA color space).
  • rgb(RED,BLUE,GREEN), where RED, BLUE,, and GREEN are either numbers in the range [0, 255] or a number (typically floating point) followed by a '%'.
  • rgba(RED,BLUE,GREEN,ALPHA), where RED, BLUE, and GREEN are either numbers in the range [0, 255] or a number (typically floating point) followed by a '%', and ALPHA varies from 0.0 (fully transparent to 1.0 (opaque).
  • hsl(HUE,SATURATION,LIGHTNESS), where HUE is in the range [0,360], SATURATION is a number in the range [0,100] followed immediately by a '%', and where LIGHTNESS is a number in the range [0,100] followed immediately by a '%'.
  • hsl(HUE,SATURATION,LIGHTNESS, ALPHA), where HUE is in the range [0,360), SATURATION is a number in the range [0,100] followed immediately by a '%', where LIGHTNESS is a number in the range [0,100] followed immediately by a '%', and where ALPHA is a floating point number in the range [0, 1].
  • a keyword denoting an X11 color with the addition of "gray" and its synonym "grey" from SVG 1.0. X11 colors are described in the document X11 color names. The variant of these names that this class uses are the ones given in the W3C recommendation cited above. These are all lower case with no whitespace.
  • the value null, indicating that this parameter is not in use.
The subparameters red, green, blue, and alpha, when not null, will override the corresponding components of the CSS color. If the css, red, green, blue, and alpha parameters are all null, a default color (possibly null) will be used.
backsideSegmentColor.green
Green
java.lang.Integer [0, 255] false set
The green component of the color (0 for none to 255 for maximum value)
backsideSegmentColor.red
Red
java.lang.Integer [0, 255] false set
The red component of the color (0 for none to 255 for the maximum value)
border
Border
double [-∞, ∞] false set
The border in user-space units to space the edges of models from the frame of an image
changeScale
Change Scale
boolean N/A false set
when true (the default) the scale will be changed so that the
colorFactor
Color Factor
double [-∞, ∞] false set
a number in the range [0.0, 1.0] scaling how colors are darkened as the z coordinate increase
edgeColor
Edge Color
(none) N/A false clear
The color used to draw edges of triangles
edgeColor.alpha
Alpha
java.lang.Integer [0, 255] false set
The alpha component of the color (0 for transparent to 255 for opaque)
edgeColor.blue
Blue
java.lang.Integer [0, 255] false set
The blue component of the color (0 for none to 255 for the maximum value)
edgeColor.css
CSS Color
java.lang.String N/A false set
The CSS specification for the color
This parameter's value provides a color via a string containing a CSS (Cascading Style Sheet) color (level 3). The specification for a CSS color, level 3, can be found in a W3C recommendation, and consists of one of the following:
  • 6 hexadecimal digits following an '#' and providing an opaque color (i.e., the alpha value is 255 in a RGBA color space).
  • rgb(RED,BLUE,GREEN), where RED, BLUE,, and GREEN are either numbers in the range [0, 255] or a number (typically floating point) followed by a '%'.
  • rgba(RED,BLUE,GREEN,ALPHA), where RED, BLUE, and GREEN are either numbers in the range [0, 255] or a number (typically floating point) followed by a '%', and ALPHA varies from 0.0 (fully transparent to 1.0 (opaque).
  • hsl(HUE,SATURATION,LIGHTNESS), where HUE is in the range [0,360], SATURATION is a number in the range [0,100] followed immediately by a '%', and where LIGHTNESS is a number in the range [0,100] followed immediately by a '%'.
  • hsl(HUE,SATURATION,LIGHTNESS, ALPHA), where HUE is in the range [0,360), SATURATION is a number in the range [0,100] followed immediately by a '%', where LIGHTNESS is a number in the range [0,100] followed immediately by a '%', and where ALPHA is a floating point number in the range [0, 1].
  • a keyword denoting an X11 color with the addition of "gray" and its synonym "grey" from SVG 1.0. X11 colors are described in the document X11 color names. The variant of these names that this class uses are the ones given in the W3C recommendation cited above. These are all lower case with no whitespace.
  • the value null, indicating that this parameter is not in use.
The subparameters red, green, blue, and alpha, when not null, will override the corresponding components of the CSS color. If the css, red, green, blue, and alpha parameters are all null, a default color (possibly null) will be used.
edgeColor.green
Green
java.lang.Integer [0, 255] false set
The green component of the color (0 for none to 255 for maximum value)
edgeColor.red
Red
java.lang.Integer [0, 255] false set
The red component of the color (0 for none to 255 for the maximum value)
lightsourcePhi
Phi for Light Source
double [-∞, ∞] false set
The angle phi in degrees for a light source
The angle this parameter specifies is the angle of a that a vector pointing towards the light source and projected onto the x-y plane makes with the X axis, measured counterclockwise.
lightsourcePhiFunction
Phi Function
org.bzdev.devqsim.SimFunction N/A false set
A function giving the light-source angle phi in radians as a function of simulation/animation time
lightsourcePhiRate
Phi Rate for Light Source
double [-∞, ∞] false set
The rate of change of the light source angle phi (degrees/unit-time)
lightsourceTheta
Theta for Light Source
double [-∞, ∞] false set
The angle theta in degrees for a light source
The angle this parameter specifies is the angle that a vector pointing towards the light source makes with Z axis.
lightsourceThetaFunction
Theta Function
org.bzdev.devqsim.SimFunction N/A false set
A function giving the light-source angle theta in radians as a function of simulation/animation time
lightsourceThetaRate
Theta Rate for Light Source
double [-∞, ∞] false set
The rate of change of the light-source angle theta
logmagnificationRate
Log-Magnification Rate
double [-∞, ∞] false set
The rate of change of the logarithm of the magnification
magnification
Magnification
double [-∞, ∞] false set
the magnification (1.0 means it will fill the frame, excluding the border)
magnificationFunction
Magnification Function
org.bzdev.devqsim.SimFunction N/A false set
A function giving the magnification as a function of simulation/animation time
phi
Phi
double [-∞, ∞] false set
The Eulerian angle phi in degrees
This parameter defines the Eulerian angle φ for a coordinate transformation to change the x, y and z axes for viewing an object. The z axis always points out of the frame of the image. A coordinate transformation described by Eulerian angles consists of a counterclockwise rotation by an angle φ about the Z axis, followed by a counterclockwise rotation by an angle θ about the new X axis, followed by a counterclockwise rotation by an angle ψ about the new Z axis.
phiFunction
Phi Function
org.bzdev.devqsim.SimFunction N/A false set
A function giving the Eulerian angle phi in radians as a function of simulation/animation time
phiRate
Phi Rate
double [-∞, ∞] false set
The rate of change of the Eulerian angle phi (degrees/unit-time)
psi
Psi
double [-∞, ∞] false set
The Eulerian angle psi in degrees
This parameter defines the Eulerian angle ψ for a coordinate transformation to change the x, y and z axes for viewing an object. The z axis always points out of the frame of the image. A coordinate transformation described by Eulerian angles consists of a counterclockwise rotation by an angle φ about the Z axis, followed by a counterclockwise rotation by an angle θ about the new X axis, followed by a counterclockwise rotation by an angle ψ about the new Z axis.
psiFunction
Psi Function
org.bzdev.devqsim.SimFunction N/A false set
A function giving the Eulerian angle psi in radians as a function of simulation/animation time
psiRate
Psi Rate
double [-∞, ∞] false set
The rate of change of the Eulerian angle psi (degrees/unit-time)
segmentColor
Segment Color
(none) N/A false clear
The color to use for line segments and the edges of subtriangles added for rendering
segmentColor.alpha
Alpha
java.lang.Integer [0, 255] false set
The alpha component of the color (0 for transparent to 255 for opaque)
segmentColor.blue
Blue
java.lang.Integer [0, 255] false set
The blue component of the color (0 for none to 255 for the maximum value)
segmentColor.css
CSS Color
java.lang.String N/A false set
The CSS specification for the color
This parameter's value provides a color via a string containing a CSS (Cascading Style Sheet) color (level 3). The specification for a CSS color, level 3, can be found in a W3C recommendation, and consists of one of the following:
  • 6 hexadecimal digits following an '#' and providing an opaque color (i.e., the alpha value is 255 in a RGBA color space).
  • rgb(RED,BLUE,GREEN), where RED, BLUE,, and GREEN are either numbers in the range [0, 255] or a number (typically floating point) followed by a '%'.
  • rgba(RED,BLUE,GREEN,ALPHA), where RED, BLUE, and GREEN are either numbers in the range [0, 255] or a number (typically floating point) followed by a '%', and ALPHA varies from 0.0 (fully transparent to 1.0 (opaque).
  • hsl(HUE,SATURATION,LIGHTNESS), where HUE is in the range [0,360], SATURATION is a number in the range [0,100] followed immediately by a '%', and where LIGHTNESS is a number in the range [0,100] followed immediately by a '%'.
  • hsl(HUE,SATURATION,LIGHTNESS, ALPHA), where HUE is in the range [0,360), SATURATION is a number in the range [0,100] followed immediately by a '%', where LIGHTNESS is a number in the range [0,100] followed immediately by a '%', and where ALPHA is a floating point number in the range [0, 1].
  • a keyword denoting an X11 color with the addition of "gray" and its synonym "grey" from SVG 1.0. X11 colors are described in the document X11 color names. The variant of these names that this class uses are the ones given in the W3C recommendation cited above. These are all lower case with no whitespace.
  • the value null, indicating that this parameter is not in use.
The subparameters red, green, blue, and alpha, when not null, will override the corresponding components of the CSS color. If the css, red, green, blue, and alpha parameters are all null, a default color (possibly null) will be used.
segmentColor.green
Green
java.lang.Integer [0, 255] false set
The green component of the color (0 for none to 255 for maximum value)
segmentColor.red
Red
java.lang.Integer [0, 255] false set
The red component of the color (0 for none to 255 for the maximum value)
theta
Theta
double [-∞, ∞] false set
The Eulerian angle theta in degrees
This parameter defines the Eulerian angle θ for a coordinate transformation to change the x, y and z axes for viewing an object. The z axis always points out of the frame of the image. A coordinate transformation described by Eulerian angles consists of a counterclockwise rotation by an angle φ about the Z axis, followed by a counterclockwise rotation by an angle θ about the new X axis, followed by a counterclockwise rotation by an angle ψ about the new Z axis.
thetaFunction
Theta Function
org.bzdev.devqsim.SimFunction N/A false set
A function giving the Eulerian angle theta in radians as a function of simulation/animation time
thetaRate
Theta Rate
double [-∞, ∞] false set
The rate of change of the Eulerian angle theta (degrees/unit-time)
time0
Initial Viewing Time
double [-∞, ∞] false set
the initial viewing time
This parameter is the initial simulation time for which a model view applies. Timeline values are relative to time0. Normally the default value of 0.0 should be used. A different value may be appropriate if one wishes to add some introductory frames, perhaps providing a title and description of the model before displaying it, and thus needs to translate the timeline by a specified amount.
timeline
Time Line
int N/A false add
The timeline that determines a views parameters as a function of time
This is an integer-keyed set of values that define changes in an object's configuration. Subclasses may provide additional timeline parameters.
timeline.changeScale
Change Scale
int
java.lang.Boolean
N/A false set
when true (the default) the scale will be changed so that the
If this parameter not provided, the previous value is used. If true, the scale will be changed so that the model will just fit inside the frame (minus the borders) when the magnification is 1.0. If false, the scale is computed once and not modified. even if subsequent rotations result in the model not fitting inside the frame.
timeline.colorFactor
Color Factor
int
java.lang.Double
[-∞, ∞] false set
a number in the range [0.0, 1.0] scaling how colors are darkened as the z coordinate increase
a number in the range [0.0, 1.0] scaling how colors are darkened as the z coordinate increase
timeline.forceScaleChange
Forced Scale Change
int
boolean
N/A false set
when true, the scale will be recomputed at least once
If this parameter has the value false (the default), nothing is done. If true, the scale will be computed or recomputed at least once (once if changeScale is false).
timeline.lightsourcePhi
Phi for Light Source
int
java.lang.Double
[-∞, ∞] false set
The angle phi in degrees for a light source
The angle this parameter specifies is the angle of a that a vector pointing towards the light source and projected onto the x-y plane makes with the X axis, measured counterclockwise.
timeline.lightsourcePhiFunction
Phi Function
int
org.bzdev.devqsim.SimFunction
N/A false set
A function giving the light-source angle phi in radians as a function of time
timeline.lightsourcePhiRate
Phi Rate for Light Source
int
java.lang.Double
[-∞, ∞] false set
The rate of change of the light source angle phi (degrees/unit-time)
timeline.lightsourceTheta
Theta for Light Source
int
java.lang.Double
[-∞, ∞] false set
The angle theta in degrees for a light source
The angle this parameter specifies is the angle that a vector pointing towards the light source makes with Z axis.
timeline.lightsourceThetaFunction
Theta Function
int
org.bzdev.devqsim.SimFunction
N/A false set
A function giving the light-source angle theta in radians as a function of time
timeline.lightsourceThetaRate
Theta Rate for Light Source
int
java.lang.Double
[-∞, ∞] false set
The rate of change of the light-source angle theta
timeline.logmagnificationRate
Log-Magnification Rate
int
java.lang.Double
[-∞, ∞] false set
The rate of change of the logarithm of the magnification
timeline.magnification
Magnification
int
java.lang.Double
[-∞, ∞] false set
the magnification (1.0 means it will fill the frame, excluding the border)
timeline.magnificationFunction
Magnification Function
int
org.bzdev.devqsim.SimFunction
N/A false set
A function giving the magnification as a function of time
timeline.phi
Phi
int
java.lang.Double
[-∞, ∞] false set
The Eulerian angle phi in degrees
This parameter defines the Eulerian angle φ for a coordinate transformation to change the x, y and z axes for viewing an object. The z axis always points out of the frame of the image. A coordinate transformation described by Eulerian angles consists of a counterclockwise rotation by an angle φ about the Z axis, followed by a counterclockwise rotation by an angle θ about the new X axis, followed by a counterclockwise rotation by an angle ψ about the new Z axis.
timeline.phiFunction
Phi Function
int
org.bzdev.devqsim.SimFunction
N/A false set
A function giving the Eulerian angle phi in radians as a function of time
timeline.phiRate
Phi Rate
int
java.lang.Double
[-∞, ∞] false set
The rate of change of the Eulerian angle phi (degrees/unit-time)
timeline.psi
Psi
int
java.lang.Double
[-∞, ∞] false set
The Eulerian angle psi in degrees
This parameter defines the Eulerian angle ψ for a coordinate transformation to change the x, y and z axes for viewing an object. The z axis always points out of the frame of the image. A coordinate transformation described by Eulerian angles consists of a counterclockwise rotation by an angle φ about the Z axis, followed by a counterclockwise rotation by an angle θ about the new X axis, followed by a counterclockwise rotation by an angle ψ about the new Z axis.
timeline.psiFunction
Psi Function
int
org.bzdev.devqsim.SimFunction
N/A false set
A function giving the Eulerian angle psi in radians as a function of time
timeline.psiRate
Psi Rate
int
java.lang.Double
[-∞, ∞] false set
The rate of change of the Eulerian angle psi (degrees/unit-time)
timeline.theta
Theta
int
java.lang.Double
[-∞, ∞] false set
The Eulerian angle theta in degrees
This parameter defines the Eulerian angle θ for a coordinate transformation to change the x, y and z axes for viewing an object. The z axis always points out of the frame of the image. A coordinate transformation described by Eulerian angles consists of a counterclockwise rotation by an angle φ about the Z axis, followed by a counterclockwise rotation by an angle θ about the new X axis, followed by a counterclockwise rotation by an angle ψ about the new Z axis.
timeline.thetaFunction
Theta Function
int
org.bzdev.devqsim.SimFunction
N/A false set
A function giving the Eulerian angle theta in radians as a function of time
timeline.thetaRate
Theta Rate
int
java.lang.Double
[-∞, ∞] false set
The rate of change of the Eulerian angle theta (degrees/unit-time)
timeline.time
Time
int
java.lang.Double
[-∞, ∞] false set
The time for a timeline entry
This parameter must be provided if a timeline entry exists. The units are those used by the double-precession time unit for the simulation (for animations, this is generally seconds).
timeline.traceSetMode
TraceSet Mode
int
org.bzdev.devqsim.TraceSetMode
N/A false set
The trace-set mode for a timeline entry
This parameter indicates how the trace sets associated with a timeline entry should be interpreted. The values are an enumeration whose type is org.bzdev.devqsim.TraceSetMode and are used as follows:
  • KEEP - keep the existing trace sets, adding additional ones specified by the parameter timeline.traceSets.
  • REMOVE - remove the trace sets specified by the parameter timeline.traceSets.
  • REPLACE - remove all existing trace sets and replace those with the ones specified by the timeline.traceSets parameter.
timeline.traceSets
Trace Sets
int
org.bzdev.devqsim.TraceSet
N/A false add
The trace sets for a timeline entry
This parameter represents a set of TraceSet objects (the three-argument add method is used to add entries). How the entries are interpreted depends on the trace set mode for this timeline entry.
timeline.visible
Visibility
int
java.lang.Boolean
N/A false set
The visibility for a timeline entry
This parameter's value determines the visibility of an object. When false the object is invisible and when true the object is visible.
timeline.xfract
X Fractional Position
int
java.lang.Double
[-∞, ∞] false set
The fractional position in the X direction
The fractional position in the X direction that this parameter provides is useful when object cannot fit in the frame. A value of 0 ensures that the left edge will be visible; a value of 1 ensures that the right edge will be visible, and intermediate values translate the model linearly between these extremes.
timeline.xfractFunction
X Fractional Position Function
int
org.bzdev.devqsim.SimFunction
N/A false set
A function giving the fraction position in the X direction as a function of time
timeline.xfractRate
X Fractional Position Rate
int
java.lang.Double
[-∞, ∞] false set
The rate of change of the fractional position in the X direction
timeline.yfract
Y Fractional Position
int
java.lang.Double
[-∞, ∞] false set
The fractional position in the Y direction
The fractional position in the Y direction that his parameter provides is useful when object cannot fit in the frame. A value of 0 ensures that the bottom edge will be visible; a value of 1 ensures that the top edge will be visible, and intermediate values translate the model linearly between these extremes.
timeline.yfractFunction
Y Fractional Position Function
int
org.bzdev.devqsim.SimFunction
N/A false set
A function giving the fraction position in the Y direction as a function of time
timeline.yfractRate
Y Fractional Position Rate
int
java.lang.Double
[-∞, ∞] false set
The rate of change of the fractional position in the Y direction
timeline.zorder
Z-Order
int
java.lang.Long
[-∞, ∞] false set
The z-order for a timeline entry
This parameter's value determines the stacking order of animation objects. Those with smaller values of this parameter are drawn before those with larger values.
traceSets
Trace Sets
org.bzdev.devqsim.TraceSet N/A false add
A set of TraceSet objects, used for tracing
This parameter provides a set of TraceSets a SimObject will use for tracing. One should use the add and remove factory methods as this parameter refers to a set of values.
visible
Visibility
boolean N/A false set
The visibility flag - objects with this set to false are invisible.
xfract
X Fractional Position
double [-∞, ∞] false set
The fractional position in the X direction
The fractional position in the X direction that this parameter provides is useful when object cannot fit in the frame. A value of 0 ensures that the left edge will be visible; a value of 1 ensures that the right edge will be visible, and intermediate values translate the model linearly between these extremes.
xfractFunction
X Fractional Position Function
org.bzdev.devqsim.SimFunction N/A false set
A function giving the fraction position in the X direction as a function of simulation/animation time
xfractRate
X Fractional Position Rate
double [-∞, ∞] false set
The rate of change of the fractional position in the X direction
yfract
Y Fractional Position
double [-∞, ∞] false set
The fractional position in the Y direction
The fractional position in the Y direction that this parameter provides is useful when object cannot fit in the frame. A value of 0 ensures that the bottom edge will be visible; a value of 1 ensures that the top edge will be visible, and intermediate values translate the model linearly between these extremes.
yfractFunction
Y Fractional Position Function
org.bzdev.devqsim.SimFunction N/A false set
A function giving the fraction position in the Y direction as a function of simulation/animation time
yfractRate
Y Fractional Position Rate
double [-∞, ∞] false set
The rate of change of the fractional position in the Y direction
zorder
Z-Order
long [-∞, ∞] false set
The stacking order - objects with lower values are drawn first.