Contents - Index - Previous - Next
Object Parameters
The following Object Types are available in all products of the Shadow Analyzer Collection.
Each item of the long list shows the Type-Name and the Type-Description, and then the sublist of Parameter-Names and Parameter-Descriptions.
Note also that each object of a particular scene has also an additional parameter "Name". Its value is a string with the "own" object name, which you can edit and use as a short comment to distinguish objects in the tree view of the scene structure. See the chapter "Advanced Options" for more details.
2D Primitives
2D_3 -- Triangle on the XY-plane of its own CS
C* -- translate triangle to center its bounding rectangle on the XY-plane (1 -- centered, 0 -- not)
dX -- X-dimension of side 1 ( > 0 ), vertices 1, 2 have coordinates (-dX/2, 0) and (+dX/2, 0)
x3 -- x-coordinate of vertex 3
y3 -- y-coordinate of vertex 3 ( > 0 )
2D_4 -- Convex quad with 4 vertices on the XY-plane of its own CS
C* -- translate quad to center its bounding rectangle on the XY-plane (1 -- centered, 0 -- not)
dX -- X-dimension of side 1 ( > 0 ), vertices 1, 2 have coordinates (-dX/2, 0) and (+dX/2, 0)
x3 -- x-coordinate of vertex 3
y3 -- y-coordinate of vertex 3 ( > 0 )
x4 -- x-coordinate of vertex 4
y4 -- y-coordinate of vertex 4 ( > 0 )
2D_5 -- Convex polygon with 5 vertices on the XY-plane of its own CS
C* -- translate polygon to center its bounding rectangle on the XY-plane (1 -- centered, 0 -- not)
dX -- X-dimension of side 1 ( > 0 ), vertices 1, 2 have coordinates (-dX/2, 0) and (+dX/2, 0)
x3 -- x-coordinate of vertex 3
y3 -- y-coordinate of vertex 3 ( > 0 )
x4 -- x-coordinate of vertex 4
y4 -- y-coordinate of vertex 4 ( > 0 )
x5 -- x-coordinate of vertex 5
y5 -- y-coordinate of vertex 5 ( > 0 )
2D_Circ -- Circular polygon on the XY-plane of its own CS
n -- number of vertices within range [3, 36]
r -- outer radius ( > 0 )
2D_Ell -- Elliptical polygon on the XY-plane of its own CS
n -- number of vertices within range [3, 36]
rx -- outer x-radius ( > 0 )
ry -- outer y-radius ( > 0 )
2D_GrR -- Rectangular centered Grid above the XY-plane of its own CS
nx -- number of cells in own X-direction within range [1, 100]
ny -- number of cells in own Y-direction within range [1, 100]
dX -- X-dimension of rectangle cell ( 0 < dX <= 100 )
dY -- Y-dimension of rectangle cell ( 0 < dY <= 100 )
hZ -- the grid plane height above the XY-plane within range [0, 100]
2D_Rect -- Rectangle on the XY-plane of its own CS
dX -- X-dimension of rectangle ( > 0 )
dY -- Y-dimension of rectangle ( > 0 )
2D_Sec -- Circular sector on the XY-plane of its own CS (CCW from X-axis)
n -- number of chords within range [1, 18]
r -- outer radius ( > 0 )
A -- central angle in degrees in range 0° < A <= 180°
2D_Seg -- Circular segment on the XY-plane of its own CS
n -- number of outer chords within range [2, 36]
r -- outer radius ( > 0 )
A -- central angle in degrees in range 0° < A <= 360°
3D Primitives
3D_Box -- the box that is centered on the XY-plane of its own CS
dX -- X dimension ( > 0 )
dY -- Y dimension ( > 0 )
dZ -- Z dimension ( > 0 )
3D_Cone -- the cone that is built on a circular polygon that is centered on the XY-plane of its own CS
n -- number of vertices of bottom circular polygon within range [3, 36]
r -- outer radius of bottom circle ( > 0 )
h -- cone height ( > 0 )
3D_Cyl -- the cylinder that is built on a circular polygon that is centered on the XY-plane of its own CS
n -- number of vertices of top/bottom circular polygon within range [3, 36]
rt -- outer radius of top circle ( > 0 )
rb -- outer radius of bottom circle ( > 0 )
h -- cylinder height ( > 0 )
3D_Cyl_nH -- the cylinder that is built on a circular polygon that is centered on the XY-plane of its own CS. Refined reflection appearance.
n -- number of vertices of top/bottom circular polygon within range [3, 36]
nh -- number of h-sections (to refine reflection appearance) within range [1, 10]
rt -- outer radius of top circle ( > 0 )
rb -- outer radius of bottom circle ( > 0 )
h -- cylinder height ( > 0 )
3D_CylE -- the cylinder that is built on an elliptical polygon that is centered on the XY-plane of its own CS
n -- number of vertices of top/bottom elliptical polygon within range [3, 36]
rxt -- outer x-radius of top ellipse ( > 0 )
ryt -- outer y-radius of top ellipse ( > 0 )
xt -- x-shift of top ellipse
yt -- y-shift of top ellipse
rxb -- outer x-radius of bottom ellipse ( > 0 )
ryb -- outer y-radius of bottom ellipse ( > 0 )
h -- cylinder height ( > 0 )
3D_CylSg -- the cylindrical segment that is built on a circular segment that is centered on the XY-plane of its own CS
n -- number of outer chords of top/bottom segments within range [2, 36]
rt -- outer radius of top segment ( > 0 )
rb -- outer radius of bottom segment ( > 0 )
h -- cylinder height ( > 0 )
A -- central angle of top/bottom segments in degrees in range 0° < A <= 360°
3D_Ell -- the ellipsoid that is centered in its own CS
nm -- number of chords along meridian within range [2, 18]
ne -- number of chords along equator within range [3, 36]
rx -- outer x-radius ( > 0 )
ry -- outer y-radius ( > 0 )
rz -- outer z-radius ( > 0 )
3D_EllSg -- the ellipsoidal segment that is centered on the XY-plane of its own CS
nm -- number of chords along meridian within range [2, 18]
ne -- number of chords along equator within range [3, 36]
rx -- outer x-radius ( > 0 )
ry -- outer y-radius ( > 0 )
rz -- outer z-radius ( > 0 )
A -- central angle (in vertical section, when rx = ry = rz) of segment in degrees in range 0° < A <= 360°
3D_Sph -- the sphere that is centered in its own CS
nm -- number of chords along meridian within range [2, 18]
ne -- number of chords along equator within range [3, 36]
r -- outer radius ( > 0 )
3D_SphSg -- the spherical segment that is centered on the XY-plane of its own CS
nm -- number of chords along meridian within range [2, 18]
ne -- number of chords along equator within range [3, 36]
r -- outer radius ( > 0 )
A -- central angle (in vertical section) of segment in degrees in range 0° < A <= 360°
Arrays
Arr Rect1s -- Array (a rectangular matrix) of one-side parallel rectangles above the XY-plane of its own CS (initially not a shadower)
nx -- the number of rectangles along the array's own X-axis within range [1, 100], the value is limited by the condition: nx * ny <= 1024 (see next parameter).
ny -- the number of rectangles along the array's own Y-axis within range [1, 100], value is limited by the condition: nx * ny <= 1024.
dX -- X-dimension of rectangle within range [0, 100]
dY -- Y-dimension of rectangle within range [0, 100]
gX -- X-gap between rectangles within range [0, 100]
gY -- Y-gap between rectangles within range [0, 100]
hZ -- stage height above the XY-plane of the array's own CS within range [0, 100]
Arr RectInc -- Array (a rectangular matrix) of inclined rectangles.
The "solar" windows of Shadow Analyzer interpret objects of this type as static solar collectors.
nx -- the number of rectangles along the array's own X-axis within range [1, 100], value is limited by the condition nx * ny <= 1024 (see next parameter).
ny -- the number of rectangles along the array's own Y-axis within range [1, 100], value is limited by the condition nx * ny <= 1024.
dX -- X-dimension of rectangle within range [0, 100]
dY -- Y-dimension of rectangle within range [0, 100]
gX -- X-gap between rectangles within range [0, 100]
gY -- Y-gap between rectangles within range [0, 100]
hZ -- stage height above the XY-plane of the array's own CS ( >= 0 )
iA -- inclination angle of Normal in degrees, Z (0°), -Y (90°), +Y (-90°), abs value <= 90°
Note: the Y-gaps gY are defined for the horizontal position of the rectangles (when iA = 0°), so that the positions of the centers of rectangles stay the same at any value of iA, and the Y-distances between the rectangles' centers stay also the same and equal to dY + gY.
Arr RectST -- Array (a rectangular matrix) of suntracking-2-axes rectangles.
The "solar" windows of Shadow Analyzer interpret objects of this type as sun-tracking solar collectors.
nx -- the number of rectangles along the array's own X-axis within range [1, 100], value is limited by the condition nx*ny <= 1024 (see next parameter).
ny -- the number of rectangles along the array's own Y-axis within range [1, 100], value is limited by the condition nx*ny <= 1024.
dX -- X-dimension of rectangle within range [0, 100]
dY -- Y-dimension of rectangle within range [0, 100]
gX -- X-gap between rectangles within range [0, 100]
gY -- Y-gap between rectangles within range [0, 100]
hC -- column height within range [0, 100], column is vertical even if the array's own XY-plane is inclined
Ex -- shift of shield plane from the rotation dead-point along Normal within range [0, 100]
Note: the X- and Y-gaps gX, gY are defined for the horizontal position of the rectangles (when the rectangles' Normals look to Zenith, and the rectangles' edges are parallel to X-, Y- axes -- as at the noon time on March 21 on the Equator). The positions of the rectangles' columns stay the same at any orientation of the rectangles, and the X- and Y-distances between them are equal to dX + gX, and dY + gY.
Simple Buildings
Bld_41 -- Building (4 walls, 1 roof plane) is centered on the XY-plane of its own CS
dX -- X dimension ( > 0 )
dY -- Y dimension ( > 0 )
hf -- front wall height ( > 0 )
hb -- back wall height ( > 0 )
ex -- x-extension of the roof's side edges outside the side walls' planes ( >= 0 )
ef -- y-extension of the roof's front edge outside the front wall plane ( >= 0 )
eb -- y-extension of the roof's back edge outside the back wall plane ( >= 0 )
Bld_42 -- Building (4 walls, 2 roof planes) is centered on the XY-plane of its own CS
dX -- X dimension ( > 0 ). Constrain: dX > 2*|xt|
dY -- Y dimension ( > 0 )
hw -- side walls' height ( > 0 )
xt -- x-position of the roof top line. Constrain: -dX/2 < xt < dX/2
hr -- roof height above the side walls' top edge ( >= 0 )
ex -- x-extension of the roof's side edges outside the side walls' planes ( >= 0 )
ey -- y-extension of the roof's front/back edges outside the front/back walls' planes ( >= 0 )
Bld_43 -- Building (4 walls, 3 roof planes) is centered on the XY-plane of its own CS
dX -- X dimension ( > 0 )
dY -- Y dimension ( > 0 ). Constrain: ft <= dY
hw -- side walls' height ( > 0 )
ft -- y-distance between the front wall's plane and the roof's front top point ( > 0 ). Constrain: ft <= dY
hr -- roof height above the side walls' top edges ( >= 0 )
ex -- x-extension of the roof's side edges outside the side walls' planes ( >= 0 )
eb -- y-extension of the roof's back edge outside the back wall's plane ( >= 0 )
Bld_44 -- Building (4 walls, 4 roof planes) is centered on the XY-plane of its own CS
dX -- X dimension ( > 0 )
dY -- Y dimension ( > 0 ). Constrain: dY >= 2*ft
hw - walls' height ( > 0 )
ft -- y-distance between the front/back wall's plane and the roof's front/back top point ( > 0 ). Constrain: ft <= dY/2
hr -- roof height above the walls' top edges ( >= 0 )
ex -- x-extension of the roof's side edges outside the side walls' planes ( >= 0 )
BlF_Orl -- Building fragment: Oriel (2 roof planes) is built on a polygon on the XY-plane of its own CS
nw -- number of walls within range [2, 5]
rwp -- outer radius of a polygon on which walls are built ( > 0 )
hw -- walls' minimal height -- the height of the lowest vertical edge ( > 0 )
hr -- roof height above the walls' minimal height ( >= 0 )
ex -- x-extension of the roof's side edges outside the side walls' edges/planes ( >= 0 )
ey -- y-extension of the roof's front edge outside the walls' front edge/plane ( >= 0 )