| Virtual Reality Toolbox™ | |
x = vrgetpref
x = vrgetpref('preference_name')
x = vrgetpref('preference_name','factory')
x = vrgetpref('factory')
preference_name | Name of the preference to read. |
x = vrgetpref returns the values of all the Virtual Reality Toolbox preferences in a structure array.
x = vrgetpref('preference_name') returns the value of the specified preference. If preference_name is a cell array of preference names, a cell array of corresponding preference values is returned.
x = vrgetpref('preference_name','factory') 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 DefaultFigure or DefaultWorld, these values are the default values for the corresponding vrfigure or vrworld property:
| Preference | Description |
|---|---|
DataTypeBool | Specifies the handling of the VRML Bool data type for vrnode/setfield and vrnode/getfield. Valid values are 'logical' and 'char'. If set to 'logical', the VRML Bool data type is returned as a logical value. If set to 'char', the Bool data type is returned 'on' or 'off'. Default is 'logical'. |
DataTypeInt32 | Specifies handling of the VRML Int32 data type for vrnode/setfield and vrnode/getfield. Valid values are 'int32' and 'double'. If set to 'int32', the VRML Int32 data type is returned as int32. If set to 'double', the Int32 data type is returned as 'double'. Default is 'double'. |
DataTypeFloat | Specifies the handling of the VRML float data type for vrnode/setfield and vrnode/getfield. Valid values are 'single' and 'double'. If set to 'single', the VRML Float and Color data types are returned as 'single'. If set to 'double', the Float and Color data types are returned as 'double'. Default is 'double'. |
DefaultFigureAnti | Determines whether antialiasing is used by default for new vrfigure objects. Valid values are 'off' and 'on'. |
DefaultFigureDeleteFcn | Specifies the default callback invoked when closing a vrfigure object. |
DefaultFigureLighting | Specifies whether the lights are rendered by default for new vrfigure objects. Valid values are 'off' and 'on'. |
DefaultFigureMax | Specifies the default maximum size of a texture used in rendering new vrfigure objects. Valid values are 'auto' and 32 <= x <= video card limit, where x is a power of 2. |
DefaultFigureNavPanel | Specifies the default appearance of the control panel in the viewer. Valid values are 'opaque', 'translucent', 'none', 'halfbar', 'bar', and 'factory'. Default is 'halfbar'. |
DefaultFigureNavZones | Specifies whether the navigation zone is on or off by default for new vrfigure objects. Valid values are 'off' and 'on'. |
DefaultFigurePosition | Sets the default initial position and size of the Virtual Reality Toolbox viewer window. Valid value is a vector of four doubles. |
DefaultFigureRecord2D | Specifies the default compression method for creating 2-D animation files for new vrfigure objects. Valid values are '', 'auto', 'lossless', and 'codec_code'. |
DefaultFigureRecord2D | Specifies the default quality of 2-D animation file compression for new vrfigure objects. Valid values are 0-100. |
DefaultFigureRecord2D | Specifies the default 2-D offline animation filename for new vrfigure objects. |
DefaultFigureRecord2DFPS | Specifies the default frames per second playback speed. |
DefaultFigureStatusBar | Specifies whether the status bar appears by default at the bottom of the Virtual Reality Toolbox viewer for new vrfigure objects. Valid values are 'off' and 'on'. |
DefaultFigureToolBar | Specifies whether the toolbar appears by default on the Virtual Reality Toolbox viewer for new vrfigure objects. Valid values are 'off' and 'on'. |
DefaultFigure | Specifies whether or not transparency information is taken into account when rendering for new vrfigure objects. Valid values are 'off' and 'on'. |
DefaultFigureWireframe | Specifies whether objects are drawn as solids or wireframes by default for new vrfigure objects. Valid values are 'off' and 'on'. |
DefaultViewer | Specifies which viewer is used to view a virtual scene. The Virtual Reality Toolbox viewer is used when the preference is set to 'internal'. The Web browser is used when this preference is set to 'web'. Default is 'internal'. |
DefaultWorldRecord3D | Specifies the default 3-D animation filename for new vrworld objects. |
DefaultWorldRecordMode | Specifies the default animation recording mode for new vrworld objects. Valid values are 'manual' and 'scheduled'. |
DefaultWorldRecord | Specifies the default start and stop times for scheduled animation recording for new vrworld objects. Valid value is a vector of two doubles. |
DefaultWorldRemoteView | Specifies whether the virtual world is enabled by default for remote viewing for new vrworld objects. Valid values are 'off' and 'on'. |
DefaultWorldTimeSource | Specifies the default source of the time for new vrworld objects. Valid values are 'external' and 'freerun'. |
Editor | Path to the VRML editor. If this path is empty, the MATLAB editor is used. |
HttpPort | IP port number used to access the VR server over the Web via HTTP. If you change this preference, you must restart the MATLAB software before the change takes effect. |
TransportBuffer | Length of the transport buffer (network packet overlay) for communication between the VR server and its clients. |
TransportTimeout | Amount of time the VR Toolbox server waits for a reply from the client. If there is no response from the client, the VR Toolbox server disconnects from the client. |
VrPort | IP port used for communication between the VR server and its clients. If you change this preference, you must restart the MATLAB software before the change takes effect. |
The HttpPort, VrPort, and TransportBuffer preferences affect Web-based viewing of virtual worlds. DefaultFigurePosition and DefaultNavPanel affect the Virtual Reality Toolbox viewer.
DefaultFigureNavPanel — Controls the appearance of the navigation panel in the Virtual Reality Toolbox viewer. For example, setting this value to 'translucent' causes the navigation panel to appear translucent.
DefaultViewer — Determines whether the virtual scene appears in the Virtual Reality Toolbox viewer or in your Web browser. If the preference is set to 'internal', the Virtual Reality Toolbox viewer is the default viewer. If it is set to 'web', the default Web browser with the VRML plug-in is the default viewer.
Editor — Contains a path to the VRML editor executable file. When you use the edit command, Virtual Reality Toolbox runs the VRML editor executable with all parameters required to edit the VRML file.
When you run the editor, Virtual Reality Toolbox uses the Editor preference value as if you typed it into a command line. The following tokens are interpreted:
%matlabroot | Refers to the MATLAB root directory |
%file | Refers to the VRML filename |
For instance, a possible value for the Editor preference is
`%matlabroot\bin\win32\meditor.exe %file'
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:
http://server.name:port_number
The default value of this preference is 8123.
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 throughput.
VrPort — Specifies the network port to use for communication between the Virtual Reality Toolbox 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 8124.
| vrgcf | vrinstall | |
| © 1984-2008- The MathWorks, Inc. - Site Help - Patents - Trademarks - Privacy Policy - Preventing Piracy - RSS |