Ray3DPlot

Rays 3D result.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Antenna_and_UTD_Plate.fek]])
rayData = app.Models[1].Configurations[1].Rays["Rays1"]

    -- Add the ray data to the 3D view
    
rayPlot = app.Views[1].Plots:Add(rayData)

    -- SetProperties the ray quantity options

rayPlot.Quantity.GroupsSelected = {1,2,3,4,5,6,7,8,9,10}

Inheritance

The Ray3DPlot object is derived from the Result3DPlot object.

Property List

AxisNames
The names of all the axes on the ResultPlot. (Read only List of string)
DataSource
The object that is the data source for this plot. (Read/Write ResultData)
Label
The object label. (Read/Write string)
Legend
The 3D plot legend properties. (Read only Plot3DLegendFormat)
Quantity
The rays 3D plot quantity properties. (Read only RaysQuantity)
Type
The object type string. (Read only string)
Visible
Specifies whether the plot must be shown or hidden. (Read/Write boolean)
Visualisation
The rays visualisation properties. (Read only Rays3DFormat)

Method List

Delete ()
Delete the plot.
Duplicate ()
Duplicate the plot. (Returns a Result3DPlot object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Store ()
Stores a copy of the plot. (Returns a Result3DPlot object.)

Property Details

AxisNames
The names of all the axes on the ResultPlot.
Access
Read only
DataSource
The object that is the data source for this plot.
Type
ResultData
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
Legend
The 3D plot legend properties.
Type
Plot3DLegendFormat
Access
Read only
Quantity
The rays 3D plot quantity properties.
Type
RaysQuantity
Access
Read only
Type
The object type string.
Type
string
Access
Read only
Visible
Specifies whether the plot must be shown or hidden.
Type
boolean
Access
Read/Write
Visualisation
The rays visualisation properties.
Type
Rays3DFormat
Access
Read only

Method Details

Delete ()
Delete the plot.
Duplicate ()
Duplicate the plot.
Return
Result3DPlot
The duplicated plot.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A properties table.
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(table)
A table of properties defining the new state of the object.
Store ()
Stores a copy of the plot.
Return
Result3DPlot
The new plot associated with the stored data.