FarField3DFormat
The far field 3D plot visualisation properties.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]]) farFieldData = app.Models[1].Configurations[1].FarFields["FarFields"] farFieldPlot = app.Views[1].Plots:Add(farFieldData) -- Configure the plot visualisation farFieldPlot.Visualisation.FlatShaded = true farFieldPlot.Visualisation.Opacity = 50 farFieldPlot.Visualisation.Origin = pf.Point(0, 0, 0.002)
Usage locations
The FarField3DFormat object can be accessed from the following locations:
- Properties
- FarField3DPlot object has property Visualisation.
Property List
- AutoExtruded
- Specifies whether auto extrusion is enabled or disabled for the far field plot. (Read/Write boolean)
- AutoSizingEnabled
- Specifies whether auto size is enabled or disabled for the far field plot. (Read/Write boolean)
- Extrusion
- The amount (%) the far 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 far field plot. (Read/Write boolean)
- GridVisible
- Specifies whether the far field plot grid must be shown or hidden. (Read/Write boolean)
- Opacity
- Specify the far field plot opacity (%) in the range [0, 100]. (Read/Write number)
- Origin
- The origin position of the far field plot. (Read/Write Point)
- Size
- The custom size (m) of the far field plot. AutoSizingEnabled needs to be disabled for this property to take affect. (Read/Write number)
- SizeFactor
- The amount (%) the far field plot should be scaled in range [0,600]. (Read/Write number)
- SurfaceVisible
- Specifies whether the far field plot surface must be shown or hidden. (Read/Write boolean)
Property Details
- AutoExtruded
- Specifies whether auto extrusion is enabled or disabled for the far field plot.
- Type
- boolean
- Access
- Read/Write
- AutoSizingEnabled
- Specifies whether auto size is enabled or disabled for the far field plot.
- Type
- boolean
- Access
- Read/Write
- Extrusion
- The amount (%) the far 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 far field plot.
- Type
- boolean
- Access
- Read/Write
- GridVisible
- Specifies whether the far field plot grid must be shown or hidden.
- Type
- boolean
- Access
- Read/Write
- Opacity
- Specify the far field plot opacity (%) in the range [0, 100].
- Type
- number
- Access
- Read/Write
- Origin
- The origin position of the far field plot.
- Type
- Point
- Access
- Read/Write
- Size
- The custom size (m) of the far field plot. AutoSizingEnabled needs to be disabled for this property to take affect.
- Type
- number
- Access
- Read/Write
- SizeFactor
- The amount (%) the far field plot should be scaled in range [0,600].
- Type
- number
- Access
- Read/Write
- SurfaceVisible
- Specifies whether the far field plot surface must be shown or hidden.
- Type
- boolean
- Access
- Read/Write