Rays3DFormat

The rays 3D plot visualisation properties.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Antenna_and_UTD_Plate.fek]])

    -- Retrieve the 'RayData' called 'Rays' and plot it on the 3D view

rayData = app.Models[1].Configurations[1].Rays["Rays1"]
rayPlot = app.Views[1].Plots:Add(rayData)
rayPlot.Quantity.GroupsSelected = {1,2,3,4,5,6,7,8,9,10}

    -- SetProperties the 3D display options for rays
    
rayPlot.Visualisation.RayGroupsVisible = true
rayPlot.Visualisation.NumbersVisible = true
rayPlot.Visualisation.AmplitudesEnabled = true

Usage locations (object properties)

The following objects have properties using the Rays3DFormat object:

Property List

AmplitudesEnabled
Specifies whether colour by magnitude as display option for the rays must be enabled. (Read/Write boolean)
IntersectionsVisible
Specifies whether the ray intersection points must be shown or hidden. (Read/Write boolean)
LinesVisible
Specifies whether the ray lines must be shown or hidden. (Read/Write boolean)
NumbersVisible
Specifies whether the ray numbers must be shown or hidden. (Read/Write boolean)
Opacity
Specify the rays plot opacity % in the range [0, 100]. (Read/Write number)
RayGroupsVisible
Specifies whether the ray group numbers must be shown or hidden. (Read/Write boolean)
Threshold
Specify the visibility threshold (%) of the rays for the range [0,100]. (Read/Write number)

Property Details

AmplitudesEnabled
Specifies whether colour by magnitude as display option for the rays must be enabled.
Type
boolean
Access
Read/Write
IntersectionsVisible
Specifies whether the ray intersection points must be shown or hidden.
Type
boolean
Access
Read/Write
LinesVisible
Specifies whether the ray lines must be shown or hidden.
Type
boolean
Access
Read/Write
NumbersVisible
Specifies whether the ray numbers must be shown or hidden.
Type
boolean
Access
Read/Write
Opacity
Specify the rays plot opacity % in the range [0, 100].
Type
number
Access
Read/Write
RayGroupsVisible
Specifies whether the ray group numbers must be shown or hidden.
Type
boolean
Access
Read/Write
Threshold
Specify the visibility threshold (%) of the rays for the range [0,100].
Type
number
Access
Read/Write