Project¶
-
class
steno3d.core.
Project
¶
Container of related Steno3D resources for plotting and uploading
Creating projects is the reason the Steno3D MATLAB toolbox exists. A
Project
contains one or more related Point, Line, Surface, or Volume
resources. They can be created and edited using the high-level plotting
interface or the low-level command line interface.
Once a Project
is created, it can be plotted in MATLAB with the plot()
function. This allows an initial visualization to verify the Project
is
constructed correctly. After the Project
is complete in MATLAB, it can
be uploaded to steno3d.com with the upload()
function. This validates
the Project
, checks user quotas, and uploads the Project
. The URL of
the uploaded Project
is returned and can also be accessed with the
url()
function.
Project implements props.HasProps for dynamic, type-checked properties
Required Properties:
Public (
props.Bool
) - Public visibility on steno3d.com, Default: falseResources (
props.Repeated
) - Composite resources the project contains, Type: props.Instance (Class: CompositeResource)
Optional Properties:
Title (
props.String
) - Content titleDescription (
props.String
) - Content description
Available Methods:
upload:
p.upload()
validates and uploads to steno3d.com the project or array of projectsp
.url = p.upload()
returns theurl
or URLs of the uploaded project(s).url:
url = p.url()
returns theurl
of an uploaded projectp
or cell array of URLs ifp
is an array of projects. This method raises an error if a project isn’t uploaded.plot:
p.plot()
plots the projectp
in a new figure window. Ifp
is an array of multiple projects, each is plotted in a new window.p.plot(ax)
plots the project(s)p
in an existing axesax
.ax = p.plot(...)
returnsax
, the axes handle of the plot or a cell array of axes handles ifp
is an array of multiple projects.It is recommended to call
plot
with no arguments (not provideax
). This prevents loss of graphics objects unrelated to the project and ensures that uploading the axes will correctly upload the project.
See the EXAMPLES
See also steno3d.core.CompositeResource, steno3d.core.UserContent