Values of Simulink 3D Animation preferences
x = vrgetpref x = vrgetpref('
preference_name') x = vrgetpref('
preference_name','factory') x = vrgetpref('
Name of the preference to read.
x = vrgetpref returns the values of all
the Simulink® 3D Animation™ preferences in a structure array.
x = vrgetpref(' returns
the value of the specified preference. If
a cell array of preference names, a cell array of corresponding preference
values is returned.
x = vrgetpref( returns
the default value for the specified preference.
x = vrgetpref('factory') returns the default
values for all the preferences.
The following preferences are defined. For preferences that
begin with the string
these values are the default values for the corresponding
Specifies the handling of the VRML
Specifies handling of the VRML
Specifies the handling of the VRML
Controls the appearance of the control panel in the
Specifies default units for new
Determines whether antialiasing is used by default for
Specifies default file name for
Specifies the default callback invoked when closing a
Specifies whether the lights are rendered by default
Specifies the default maximum size of a texture used
in rendering new
Specifies the default appearance of the control panel
in the viewer. Valid values are
Specifies whether the navigation zone is on or off by
default for new
Sets the default initial position and size of the Simulink 3D Animation Viewer window. Valid value is a vector of four doubles.
Specifies the default compression method for creating
2-D animation files for new
Specifies the default quality of 2-D animation file compression
Specifies the default 2-D offline animation file name
Specifies the default frames per second playback speed.
have the 2D AVI animation play back at approximately the same playback
speed as the 3D VRML animation, set this preference to
Specifies whether the status bar appears by default at
the bottom of the Simulink 3D Animation Viewer for new
Specifies whether textures should be rendered by default
Specifies whether the toolbar appears by default on the Simulink 3D Animation Viewer
Specifies whether or not transparency information is
taken into account when rendering for new
Specifies whether objects are drawn as solids or wireframes
by default for new
Specifies which viewer is used to view a virtual scene.
Specifies the default 3-D animation file name for new
Specifies the default animation recording mode for new
Specifies the default start and stop times for scheduled
animation recording for new
Specifies whether the virtual world is enabled by default
for remote viewing for new
Specifies the default source of the time for new
Path to the VRML editor. If this path is empty, the MATLAB editor is used.
Specifies whether the 3D World Editor starts up with
a saved version of the layout of a virtual world when you exited it
or reverts to the default layout. The layout of the virtual world
display pane includes settings for the view, viewpoints, navigation,
and rendering. Valid values are
IP port number used to access the Simulink 3D Animation server over the Web via HTTP. If you change this preference, you must restart the MATLAB software before the change takes effect.
Length of the transport buffer (network packet overlay) for communication between the Simulink 3D Animation server and its clients.
Amount of time the Simulink 3D Animation server waits for a reply from the client. If there is no response from the client, the Simulink 3D Animation server disconnects from the client.
IP port used for communication between the Simulink 3D Animation server and its clients. If you change this preference, you must restart the MATLAB software before the change takes effect.
TransportBuffer preferences affect Web-based
viewing of virtual worlds.
the Simulink 3D Animation Viewer.
DefaultFigureNavPanel — Controls the
appearance of the navigation panel in the Simulink 3D Animation Viewer.
For example, setting this value to
the navigation panel to appear translucent.
DefaultViewer — Determines whether
the virtual scene appears in the default Simulink 3D Animation Viewer,
based on MATLAB figure windows, the legacy Simulink 3D Animation Viewer,
or in your Web browser.
Default Simulink 3D Animation Viewer. This is the
same as setting the value to
Simulink 3D Animation Viewer that is the previous default viewer for most platforms. This viewer continues to be the default viewer for Linux platforms.
Viewer based on MATLAB figure windows.
Viewer is the default Web browser with the VRML plug-in.
If you are running the Simulink 3D Animation software on
a Linux platform, the default viewer continues to be legacy viewer,
which does not support MATLAB figures. If you have a Linux platform
and want to access the MATLAB figure capability, you must install
the hardware-accelerated OpenGL® rendering engine. Otherwise,
the Simulink 3D Animation software cannot properly display the
viewer. You can then activate the viewer by using
Editor — Contains a path to the VRML
editor executable file. When you use the
edit command, Simulink 3D Animation runs
the VRML editor executable with all parameters required to edit the
When you run the editor, Simulink 3D Animation uses the
value as if you typed it into a command line. The following tokens
Refers to the MATLAB root folder
Refers to the VRML file name
For instance, a possible value for the
If this preference is empty, the MATLAB editor is used.
HttpPort -- Specifies the network port to
be used for Web access. The port is given in the Web URL as follows:
The default value of this preference is
TransportBuffer — Defines the size
of the message window for client-server communication. This value
determines how many messages, at a maximum, can travel between the
client and the server at one time.
Generally, higher values for this preference make the animation run more smoothly, but with longer reaction times. (More messages in the line create a buffer that compensates for the unbalanced delays of the network transfer.)
The default value is
5, which is optimal
for most purposes. You should change this value only if the animation
is significantly distorted or the reaction times are very slow. On
fast connections, where delays are introduced more by the client rendering
speed, this value has very little effect. Viewing on a host computer
is equivalent to an extremely fast connection. On slow connections,
the correct value can improve the rendering speed significantly but,
of course, the absolute maximum is determined by the maximum connection
VrPort — Specifies the network port
to use for communication between the Simulink 3D Animation server
(host computer) and its clients (client computers). Normally, this
communication is completely invisible to the user. However, if you
view a virtual world from a client computer, you might need to configure
the security network system (firewall) so that it allows connections
on this port. The default value of this preference is