NearField3DFormat

The near field 3D plot visualisation properties.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])    
nearFieldPlot = app.Views[1].Plots:Add(app.Models[1].Configurations[1].NearFields[1])

    -- Adjust near field 3D plot visualisation properties

nearFieldPlot.Visualisation.BoundingBoxVisible = true
nearFieldPlot.Visualisation.FlatShaded = true

Usage locations (object properties)

The following objects have properties using the NearField3DFormat object:

Property List

AutoExtruded
Specifies whether auto extrusion is enabled or disabled for the near field plot. (Read/Write boolean)
BoundingBoxVisible
Specifies whether the near field plot bounding box must be shown or hidden. (Read/Write boolean)
Extrusion
The amount (%) the near field plot should be extruded in range [0,100]. (Read/Write number)
FlatShaded
Specifies whether discrete colours (flat shading) should be enabled or disabled for the near field plot. (Read/Write boolean)
GridVisible
Specifies whether the near field plot grid must be shown or hidden. (Read/Write boolean)
Opacity
Specify the near field plot opacity (%) in the range [0, 100]. (Read/Write number)
SurfaceVisible
Specifies whether the near field plot surface must be shown or hidden. (Read/Write boolean)

Property Details

AutoExtruded
Specifies whether auto extrusion is enabled or disabled for the near field plot.
Type
boolean
Access
Read/Write
BoundingBoxVisible
Specifies whether the near field plot bounding box must be shown or hidden.
Type
boolean
Access
Read/Write
Extrusion
The amount (%) the near field plot should be extruded in range [0,100].
Type
number
Access
Read/Write
FlatShaded
Specifies whether discrete colours (flat shading) should be enabled or disabled for the near field plot.
Type
boolean
Access
Read/Write
GridVisible
Specifies whether the near field plot grid must be shown or hidden.
Type
boolean
Access
Read/Write
Opacity
Specify the near field plot opacity (%) in the range [0, 100].
Type
number
Access
Read/Write
SurfaceVisible
Specifies whether the near field plot surface must be shown or hidden.
Type
boolean
Access
Read/Write