Virtual Reality Toolbox

vrfigure/get

Read a property value of a vrfigure object

Syntax

• get(vrfigure_object)
  x = get(vrfigure_object, 'property_name')
  

Arguments

vrfigure_object	Name of a vrfigure object.
property_name	Name of the property.

Description

The get(vrfigure_object) method returns the object properties of the vrfigure object. This method is useful when you want to determine the current values of these properties.

The following are properties of vrfigure objects.

Property	Value	Description
Antialiasing	'off' | 'on' Default: off	Determine whether antialiasing is used when rendering scene. Antialiasing smoothes textures by interpolating values between texture points. Read/write.
CameraBound	'off' | 'on' Default: on	Control whether or not the camera moves with the current viewpoint. Read/write.
CameraDirection	Vector of three doubles	Specify the camera direction relative to the direction of the current viewpoint. Read/write.
CameraDirectionAbs	Vector of three doubles	Specify the camera direction in world coordinates. Read-only.
CameraPosition	Vector of three doubles	Specify the camera position relative to the position of the current viewpoint. Read/write.
CameraPositionAbs	Vector of three doubles	Specify the camera position in world coordinates. Read-only.
CameraUpVector	Vector of three doubles	Specify the camera up vector relative to the up vector of the current viewpoint. Read/write.
CameraUpVectorAbs	Vector of three doubles	Specify the camera up vector in world coordinates. Read-only.
DeleteFcn	String	Callback invoked when closing the vrfigure object. Read/write.
Headlight	'off' | 'on' Default: on	Turn the headlight on or off. Read/write.
Lighting	'off' | 'on' Default: on	Turn the lighting of the scene on or off. Without lighting, the scene loses its three-dimensional quality. Read/write.
Name	String	Name of this vrfigure object. Read/write.
PanelMode	'opaque' 'translucent' 'off' 'halfbar' 'bar' Default: 'halfbar'	Control the appearance of the control panel in the Virtual Reality Toolbox viewer window. Read/write.
Position	Vector of four doubles	Screen coordinates of this vrfigure object. Read/write.
Textures	'off' | 'on' Default: on	Turn texture rendering on or off. Read/write.
Transparency	'off' | 'on' Default: on	Specify whether or not transparency information is taken into account when rendering. Read/write.
Viewpoint	String If active viewpoint does not have a name, value is empty.	Vrfigure object's active viewpoint. Read/write.
Wireframe	'off' | 'on' Default: off	Specify whether objects are drawn as solids or wireframes. Read/write.
World	Vrworld object	World this vrfigure object is displaying. Read only
ZoomFactor	Double	Camera zoom factor. Read/write.

Example

Create a vrworld object:

• myworld = vrworld('vrmount.wrl');
  

The vrworld object myworld is associated with the virtual world vrmount.wrl. Open the world:

• open(myworld)
  

Create a vrfigure object:

• f = vrfigure(myworld);
  

You can now get the object properties of the vrfigure object f:

• get(f)
  

This returns the following object properties:

•     Antialiasing = 'off'
      CameraBound = 'on'
      CameraDirection = [0 0 -1]
      CameraDirectionAbs = [0 -0.198669 -0.980067]
      CameraPosition = [0 0 0]
      CameraPositionAbs = [20 4 50]
      CameraUpVector = [0 1 0]
      CameraUpVectorAbs = [0 0.980067 -0.198669]
      Headlight = 'on'
      Lighting = 'on'
      Name = 'VR Car in the Mountains'
      PanelMode = 'opaque'
      Textures = 'on'
      Transparency = 'on'
      Viewpoint = 'View1'
      Wireframe = 'off'
      ZoomFactor = 1
  

See Also

vrfigure/set, vrfigure

vrfigure/close

vrfigure/isvalid