Pyramid

Create solid or surface rectangular pyramid or frustum in 3D.

Syntax

model.component(<ctag>).geom(<tag>).create(<ftag>,"Pyramid");

model.component(<ctag>).geom(<tag>).feature(<ftag>).set(property,<value>);

model.component(<ctag>).geom(<tag>).feature(<ftag>).getType(property);

model.component(<ctag>).geom(<tag>).feature(<ftag>).setAttribute(attribute,<value>);

model.component(<ctag>).geom(<tag>).feature(<ftag>).getAttribute(attribute);

Description

Use model.component(<ctag>).geom(<tag>).create(<ftag>,"Pyramid") to create a pyramid. The following properties are available:

Table 3-135: Valid Property/Value Pairs
Property	Value	Default	Description
a, b	double	1	Side lengths for bottom rectangle.
axis	double[]	{0,0,1}	Direction of the axis orthogonal to the bottom rectangle. Vector has length 3 if axistype is cartesian, and length 2 if axistype is spherical.
axistype	x \| y \| z \| cartesian \| spherical	z	Coordinate system used for axis. The value is synchronized with axis.
color	none \| custom \| integer between 1 and the number of colors in the current theme	none	The color of the selection, either given as an integer indicating a color in the color theme, or as a custom color in the customcolor property. Coloring is only available when selresult in active.
customcolor	RGB-triplet	Next available theme color	The color to use. Active when color is set to custom.
h	double	1	Height.
pos	double[]	{0,0,0}	Center of the bottom rectangle.
rat	double	0.5	Ratio of perimeter of top rectangle and bottom rectangle.
rot	double	0	Rotational angle about axis.
type	solid \| surface	solid	Object type.
selresult	on \| off	off	Create selections of all resulting objects.
selresultshow	all \| obj \| dom \| bnd \| edg \| pnt \| off	dom	Show selections, if selresult is on, of resulting objects in physics, materials, and so on, or in part instances. obj is not available in a component’s geometry. dom, bnd, and edg are not available in all features.
contributeto	String	none	Tag of cumulative selection to contribute to.
workplanesrc	this \| Part Instance feature	this	Part Instance feature to take the work plane from.
workplane	xyplane \| Work plane feature	xyplane	Work Plane feature that defines the coordinate system. The default, xyplane, is the global Cartesian coordinate system.

For information about the selresult and contributeto properties, see Selections of Geometric Entities.

The following attributes are available:

Table 3-136: Valid attributes
Name	Value	Default	Description
construction	on \| off	off	Designate the resulting objects as construction geometry.

Compatibility

model.component(<ctag>).geom(<tag>).create(<ftag>,"pyramid3") creates a solid pyramid.

model.component(<ctag>).geom(<tag>).create(<ftag>,"pyramid2") creates a surface pyramid.

The following properties are also available:

Table 3-137: Valid Property/Value Pairs
Property	Value	Default	Description
ax2	double[]	{0,0}	Alias for axis when axistype is spherical.
ax3	double[]	{0,0,1}	Alias for axis when axistype is cartesian.
x, y, z	double	0	Alias for pos.