platformPlotter

R2026b

Platform plotter for theater plot

Description

A PlatformPlotter object defines a platform plotter belonging to a theaterPlot object. Use the plotPlatform function to plot platforms using the PlatformPlotter object.

Creation

Syntax

pPlotter = platformPlotter(tp)

pPlotter = platformPlotter(tp,Name,Value)

Description

pPlotter = platformPlotter(tp) creates a PlatformPlotter object for use with the theater plot tp.

pPlotter = platformPlotter(tp,Name,Value) creates a PlatformPlotter object with additional options specified by one or more name-value arguments. Specify optional properties using name-value arguments.

Input Arguments

tp — Theater plot

theaterPlot object

Theater plot, specified as a theaterPlot object.

Properties

DisplayName — Plot name to display in legend

character vector | string scalar

Plot name to display in legend, specified as a character vector or string scalar. If you do not specify this property, no entry is shown in the legend.

Marker — Marker symbol

'^' (default) | character vector | string scalar

Marker symbol, specified as one of these values.

Marker	Description	Resulting Marker
"o"	Circle
"+"	Plus sign
"*"	Asterisk
"."	Point
"x"	Cross
"_"	Horizontal line
"|"	Vertical line
"square"	Square
"diamond"	Diamond
"^"	Upward-pointing triangle
"v"	Downward-pointing triangle
">"	Right-pointing triangle
"<"	Left-pointing triangle
"pentagram"	Pentagram
"hexagram"	Hexagram
"none"	No markers	Not applicable

MarkerSize — Size of marker

6 (default) | positive integer

Size of marker in points, specified as a positive integer.

MarkerEdgeColor — Marker outline color

'black' (default) | character vector | string scalar | RGB triplet | hexadecimal color code

Marker outline color, specified as a character vector, a string scalar, an RGB triplet, or a hexadecimal color code.

MarkerFaceColor — Marker fill color

'none' (default) | character vector | string scalar | RGB triplet | hexadecimal color code

Marker fill color, specified as a character vector, a string scalar, an RGB triplet, a hexadecimal color code, or 'none'.

FontSize — Font size for labeling platforms

10 (default) | positive integer

Font size for labeling platforms, specified as a positive integer that represents font point size.

LabelOffset — Gap between label and positional point

[0 0 0] (default) | three-element row vector

Gap between label and positional point it annotates, specified as a three-element row vector. Specify the [x y z] offset in meters.

VelocityScaling — Scale factor for magnitude length of velocity vectors

1 (default) | positive scalar

Scale factor for magnitude length of velocity vectors, specified as a positive scalar. The plot renders the magnitude vector value as VK, where V is the magnitude of the velocity in meters per second, and K is the value of VelocityScaling.

Tag — Tag associated with plotter

'PlotterN' (default) | character vector | string scalar

Tag associated with the plotter, specified as a character vector or string scalar. The default value is 'PlotterN', where N is an integer that corresponds to the Nth plotter associated with the theaterPlot. You can use the findPlotter function to identify plotters based on their tag.

Object Functions

plotPlatform	Plot set of platforms in platform plotter
clearData	Clear data from specific plotter of theater plot
clearPlotterData	Clear plotter data from theater plot

Examples

Create and Update Theater Plot Platforms

Create a theater plot.

tp = theaterPlot('XLim',[0,90],'YLim',[-35,35],'ZLim',[1,10]);

Create a platform plotter with the name 'Platforms'.

plotter = platformPlotter(tp,'DisplayName','Platforms');

Update the theater plot with three platforms labeled, 'R1', 'R2', and 'R3'. Position the three platforms, in units of meters, at $\left(30,5,4\right)$, $\left(30,-10,2\right)$, and $\left(30,15,1\right)$, with corresponding velocities (in m/s) of $\left(-10,0,2\right)$, $\left(-10,3,1\right)$, and $\left(-10,-4,1\right)$, respectively.

positions = [30, 5, 4; 30, -10, 2; 30, 15, 1];
velocities = [-10, 0, 2; -10, 3, 1; -10, -4, 1];
labels = {'R1','R2','R3'};
plotPlatform(plotter, positions, velocities, labels);

Change the view angles to view in 3-D.

view([-57.7 -25.9]);

Version History

Introduced in R2018b