vrdImmersiveMenu

Summary

Functions:

• attachTo(origin, constraint)
• getConstraint() → vrdImmersiveMenu.MenuConstraint
• getDepth() → float
• getHeight() → float
• getName() → string
• getOrigin() → vrdImmersiveMenu.MenuOrigin
• getRotation() → QVector3D
• getTranslation() → QVector3D
• getWidth() → float
• isVisible() → bool
• setConstraint(value)
• setContent(content)
• setDepth(value)
• setHeight(value)
• setModule(moduleTitle)
• setName(value)
• setOrigin(value)
• setRotation(rotation)
• setRotation(xDeg, yDeg, zDeg)
• setTranslation(position)
• setTranslation(x, y, z)
• setUrl(url, pixelWidth, pixelHeight)
• setVisible(value)
• setWidget(widget)
• setWidth(value)

Functions

vrdImmersiveMenu.attachTo(origin, constraint)

Reattaches the menu.

Parameters:	origin (integer) – New Origin constraint (integer) – Constraint to use

vrdImmersiveMenu.getConstraint()

Returns:	Gets the current constraint
Return type:	vrdImmersiveMenu.MenuConstraint

vrdImmersiveMenu.getDepth()

Returns:	The depth of the menu
Return type:	float

vrdImmersiveMenu.getHeight()

Returns:	The height of the menu
Return type:	float

vrdImmersiveMenu.getName()

Returns:	The name of the menu
Return type:	string

vrdImmersiveMenu.getOrigin()

Returns:	Gets the origin for the menu
Return type:	vrdImmersiveMenu.MenuOrigin

vrdImmersiveMenu.getRotation()

Returns:	The current rotation angles
Return type:	QVector3D

vrdImmersiveMenu.getTranslation()

Returns:	The current translation
Return type:	QVector3D

vrdImmersiveMenu.getWidth()

Returns:	The width of the menu
Return type:	float

vrdImmersiveMenu.isVisible()

Returns:	True, if the menu is visible
Return type:	bool

vrdImmersiveMenu.setConstraint(value)

Changes the transformation constraint.

Parameters:	value (vrdImmersiveMenu.MenuConstraint) – Constraint

vrdImmersiveMenu.setContent(content)

Use the given string to show the content.

Parameters:	content (string) – VRED tries to guess what content to show

vrdImmersiveMenu.setDepth(value)

Sets the depth of the menu.

Parameters:	value (float) – Depth in mm

vrdImmersiveMenu.setHeight(value)

Sets the height of the menu.

Parameters:	value (float) – Height in mm

vrdImmersiveMenu.setModule(moduleTitle)

Use the given name to find a module to be displayed on the menu.

Parameters:	moduleTitle (string) – Name of the module

vrdImmersiveMenu.setName(value)

Changes the name of the menu.

Parameters:	value (string) – New menu name

vrdImmersiveMenu.setOrigin(value)

Changes the origin for the menu.

Parameters:	value (vrdImmersiveMenu.MenuOrigin) – New attachment point

vrdImmersiveMenu.setRotation(rotation)

Changes rotation of the menu relative to the selected origin.

Parameters:	rotation (QVector3D) – New rotation angles

vrdImmersiveMenu.setRotation(xDeg, yDeg, zDeg)

Changes rotation of the menu relative to the selected origin.

Parameters:	xDeg (float) – X achsis rotation yDeg (float) – Y achsis rotation zDeg (float) – Z achsis rotation

vrdImmersiveMenu.setTranslation(position)

Changes position of the menu relative to the selected origin.

Parameters:	position (QVector3D) – New position

vrdImmersiveMenu.setTranslation(x, y, z)

Changes position of the menu relative to the selected origin.

Parameters:	x (float) – X coordinate y (float) – Y coordinate z (float) – Z coordinate

vrdImmersiveMenu.setUrl(url, pixelWidth=800, pixelHeight=600)

Use the given url to show web content on the mneu.

Parameters:	url (string) – Html link pixelWidth (integer) – Horzontal pixel resolution pixelHeight (integer) – Vertical pixel resolution

vrdImmersiveMenu.setVisible(value)

Shows or hides the menu.

Parameters:	value (bool) – If True, the menu is visible

vrdImmersiveMenu.setWidget(widget)

Parameters:	widget (QObject) –

vrdImmersiveMenu.setWidth(value)

Sets the width of the menu.

Parameters:	value (float) – Width in mm