get

Class: vrfigure

(To be removed) Return property value of vrfigure object

vrfigure.get will be removed in a future release. For more information, see Version History.

Syntax

get(figure)
figureProp = get(figure,propertyName)


Description

get(figure) lists the values of all the properties of the vrfigure object.

figureProp = get(figure,propertyName) returns the value of the specified property of the vrfigure object.

Input Arguments

figure — Virtual reality figure

vrfigure object

Virtual reality figure, specified as a vrfigure object.

property_name — Virtual reality figure object property

string

Virtual reality figure property, specified as one of these.

vrfigure Property	Meaning
Antialiasing	Smooth textures using antialiasing, which interpolates values between texture points.
CameraBound	Camera movement with the current viewpoint.
CameraDirection	Camera direction in the current viewpoint local coordinates.
CameraDirectionAbs	Camera direction in the world coordinates. (read-only property).
CameraPosition	Camera position in the current viewpoint local coordinates.
CameraPositionAbs	Camera position in world coordinates (read-only property).
CameraUpVector	Camera up vector.
CameraUpVectorAbs	Camera up vector in world coordinates (read-only property).
CaptureFileFormat	File format for a captured frame file.
CaptureFileName	Frame capture file name.
DeleteFcn	Callback invoked when closing the vrfigure object.
ExaminePivotPoint	Pivot point about which camera is rotated in examine navigation mode, in world coordinates.
Fullscreen	Full screen display of figure.
Headlight	Headlight from camera.
Lighting	Lighting effect.
MaxTextureSize	Maximum pixel size of a texture used. The smaller the size, the faster the texture can render. A value of 'auto' means the texture is set to the maximum pixel size.
Name	Name of figure.
NavMode	Navigation mode. See Mouse Navigation.
NavPanel	Navigation panel appearance.
NavSpeed	Navigation speed.
NavZones	Navigation zones display.
Position	Screen coordinates of figure.
Record2D	2-D offline animation file recording.
Record2DCompress Method	Compression method for creating 2-D animation files. See profile in the MATLAB® VideoWriter documentation.
Record2DCompress Quality	Quality of 2-D animation file compression. See the MATLAB VideoWriter documentation.
Record2DFileName	Name of 2-D offline animation file. The string can contain tokens that animation recording replaces with information. See File Name Tokens.
Record2DFPS	Rate of playback for the 2-D offline animation video in frames per second (fps).
Rendering	Specifies whether to render a vrfigure object. Turning off rendering improves performance. For example, if your code does batch operations on a virtual figure, you can turn off rendering during that processing and then turn it back on after the processing.
Sound	Sound effects.
StatusBar	Status bar display.
Stereo3D	Stereoscopic vision mode.
Stereo3DCameraOffset	Distance in virtual world units of left and right camera from parallax for stereoscopic vision. Parallax is the difference in the apparent position of an object viewed from two cameras.
Stereo3DHIT	Horizontal image translation (HIT) of the two stereo images in stereoscopic vision, represented by a value from 0 to 1, inclusive. The larger the value, the further back the background appears.
Textures	Texture use.
ToolBar	Toolbar display.
Tooltips	Tooltips display in navigation panel.
Transparency	Transparency effect.
Triad	Location of the triad.
Viewpoint	Active viewpoint of figure.
Wireframe	Wireframe display.
World	Virtual world that the figure displays (read-only property).
ZoomFactor	Camera zoom factor.

Output Arguments

figureProp — Virtual reality figure property

string | vector

Virtual reality figure property, returned as a string or vector.

Examples

Return All Property Values of a Figure

Create a vrfigure object.

myworld = vrworld('vrmount');
open(myworld);
virtual_fig = vrfigure(myworld);

Return the properties of the virtual figure virtual_fig.

get(virtual_fig)

 
	Antialiasing = 'on'
	CameraBound = 'on'
	CameraDirection = [0 0 -1]
	CameraDirectionAbs = [0 -0.198669 -0.980067]
	CameraPosition = [0 0 0]
	CameraPositionAbs = [20 8 50]
	CameraUpVector = [0 1 0]
	CameraUpVectorAbs = [0 0.980067 -0.198669]
	CaptureFileFormat = 'tif'
	CaptureFileName = '%f_anim_%n.tif'
	DeleteFcn = ''
	ExaminePivotPoint = [0 0 0]
	Fullscreen = 'off'
	Headlight = 'on'
	Lighting = 'on'
	MaxTextureSize = 'auto'
	Name = 'VR Car in the Mountains'
	NavMode = 'examine'
	NavPanel = 'halfbar'
	NavSpeed = 'normal'
	NavZones = 'off'
	Position = [5 92 576 350]
	Record2D = 'off'
	Record2DCompressMethod = 'auto'
	Record2DCompressQuality = 75
	Record2DFPS = 'auto'
	Record2DFileName = '%f_anim_%n.avi'
	Rendering = 'on'
	Sound = 'on'
	StatusBar = 'on'
	Stereo3D = 'off'
	Stereo3DCameraOffset = 0.1
	Stereo3DHIT = 0
	Textures = 'on'
	ToolBar = 'on'
	Tooltips = 'on'
	Transparency = 'on'
	Triad = 'none'
	Viewpoint = 'View 1 - Observer'
	Wireframe = 'off'
	World = vrworld object: 1-by-1
	ZoomFactor = 1
 

Return Name of a Figure

Create a vrfigure object.

myworld = vrworld('vrmount');
open(myworld);
virtual_fig = vrfigure(myworld);

Return the properties of the virtual figure virtual_fig.

figure_name = get(virtual_fig,'Name')

figure_name = 
'VR Car in the Mountains'

Version History

Introduced before R2006a

R2023b: To be removed

The get will be removed in a future release. Instead, use sim3d classes and Simulation 3D blocks to interface MATLAB and Simulink^® with the Unreal Engine^® 3D simulation environment. To get started, see Create 3D Simulations in Unreal Engine Environment.