Go to www.awrcorp.com
Back to search page Click to download printable version of this guide.

3.5.1.15. Surface Regular Polygon

Description

A surface representing the interior of a regular polygon.

Parameters

Label – A unique name that identifies the solid. (ISolid/Label)

Coordinate System – The coordinate system in which the solid is defined. Defaults to working coordinate system at time of creation. (ISolid/CoordinateSystem)

Material – Chosen material for the solid. (ISolid/Material)

Include in Simulation – Indicates if the solid is included in the simulation.  If False, the solid is also not shown in the view. (ISolid/Include)

Visible - Indicates if the solid is shown in the view. (ISolid/Visible)

Mesh Control Only - Indicates if the solid is used as a tool to control meshing. If True, the portion of the solid that does not overlap the other normal solid is thrown away prior to simulation. Additionally, the material of such a solid is irrelevant so the material parameter is hidden. (ISolid/MeshControlOnly)

Plane – Plane of the solid's coordinate system that the surface lies in. (ISurface/Plane)

Center - [LENGTH] – Center of the polygon defined in the solid’s coordinate system. (ISurfaceCircle/Center)

Radius - [LENGTH] - Radius of the polygon. (ISurfaceCircle/Radius)

Number of Sides - Number of sides in the polygon. (ISurfaceRegularPolygon/NumberOfSides)

Example(s)

User Interface Button

Command Details

The Plane is inherited from the current working plane. Mouse click order is:
1. Center
2. Radius
See command hint for detailed instructions.

Requirements

Radius must be greater than zero. Number of sides must be greater than 2.

Other Notes

None.

Example Creation Script

Solid_1 = Geometry_1.SurfaceRegularPolygon("Polygon_1", "World", "Air", "XY", "-0.009, 0.008, 0", "0.005", "8")

Scripting Interfaces

“ISolid”
“ISurfaceRegularPolygon”
“ISurfaceCircle”
“ISurface”
“ISolidCreationOperation”
“ISolidOperation”

Please send email to awr.support@ni.com if you would like to provide feedback on this article. Please make sure to include the article link in the email.

Legal and Trademark Notice