XML Documentation for gmGraphics

This page lists elements defined in the gmGraphics module and parameters (P), containers (C), their types and their corresponding C++ methods.

Parameters are set either as attributes or with the param tag, e.g. <param name="fullscreen" value="true">. Containers are typically automatically associated with the child type, through the Object::getDefaultKey() method, however it can be explicitly controlled through the KEY="container" attribute. Observe also that futher documentation for how an attribute should be used is sometimes available adjacent to the C++ methods.

XML attributes are parsed by stream operators. For more information about how this is done, refer to the documentation of the respective stream operator in the gramods namespace.

AngularFisheyeCoordinatesMapper

Coordinates mapper that provides an angular fisheye mapping between 2D and fully spherical 3D. (more)

	Attribute	Type	Method	Documentation
P	coverageAngle	angle	setCoverageAngle	Set the vertical coverage that the 2D coordinates (y=[-1, 1]) should have in the 3D sphere, as angle expressed as a value in radians between 0 and 2π.

ChromaKeyTexture

Decoder of Yuv encoded texture into a new texture. (more)

	Attribute	Type	Method	Documentation
P	key	float3	setKey	Set the RGB key to mask with.
C	texture	TextureInterface	setTexture	Sets the texture to decode.
P	tolerance	float2	setTolerance	Set the minimum and maximum tolerances against the key when masking.

ChromaKeyView (extends View)

The ChromaKeyView filters another view making it transparent where the chroma key is matched within the CbCr color space within a specified tolerance. (more)

	Attribute	Type	Method	Documentation
P	key	float3	setKey	Set the RGB key to mask with.
P	tolerance	float2	setTolerance	Set the minimum and maximum tolerances against the key when masking.
C	view	View	addView	Adds a view to mask with chroma key.

CubeSceneRenderer (extends Renderer)

A renderer that draws a set of cubes, for demonstration and testing purposes. (more)

	Attribute	Type	Method	Documentation
P	animate	bool	setAnimate	Set animation on or off.
P	cubeSetSize	float	setCubeSetSize	Sets the size of the set of cubes.
P	cubeSize	float	setCubeSize	Sets the size of each cube to be drawn.

EacCoordinatesMapper

Coordinates mapper that provides an Equi-angular Cubemap (EAC) mapping between 2D and fully spherical 3D. (more)

	Attribute	Type	Method	Documentation
P	layout	string	setLayout	Sets the cubemap layout through a string of row-wise cube sides, optionally rotated, and row-break(s).

EquirectangularCoordinatesMapper

Coordinates mapper that provides an equirectangular mapping between 2D and fully spherical 3D. (more)

	Attribute	Type	Method	Documentation
P	coverageAngle	angle2	setCoverageAngle	Set the horizontal and vertical coverage angles, respectively, that the 2D coordinates (y=[-1, 1]) should have in the 3D sphere, as angle expressed as a value in radians between 0 and 2π for horizontal and between 0 and π for vertical.
P	coverageRange	angle4	setCoverageRange	Set the horizontal and vertical coverage ranges, respectively, that the 2D coordinates (y=[-1, 1]) should have in the 3D sphere, as angle expressed as a value in radians typically between -π and π for horizontal and between -π/2 and π/2 for vertical.

FisheyeCameraModel

Coordinates mapper that compensates for the optical effects as described by a fisheye camera model. (more)

	Attribute	Type	Method	Documentation
P	distortion	float4	setDistortion	Set the distortion parameters (k1 k2 k3 k4) for the camera model.
P	focalDistance	float2	setFocalDistance	Set the focal distance (fx fy) for the camera model.
P	focalOffset	float2	setFocalOffset	Set the focal offset (cx cy) for the camera model.

FovPlanarView (extends View)

This view provides skewed frustum projection of the renderers. (more)

	Attribute	Type	Method	Documentation
P	clipAngles	angle4	setClipAngles	Angles between forward direction and the clip planes left, right, bottom and top, in radians.
P	clipPlanes	float4	setClipPlanes	Sets the clip planes, left, right, bottom, top, in x, y coordinates at distance 1.
P	orientation	Quaternionf	setOrientation	Sets the orientation of the View.

Geometry

A Geometry contains information for projection of graphics on a geometrical shape, such as a sphere or a plane. (more)

	Attribute	Type	Method	Documentation
P	inside	bool	setInside	Set true if the projection should be calculated for the inside of the geometry, and not the outside.

GeometryCorrectedProjectorView (extends MultiscopicView)

Geometrically corrected projector view, a view that is undistorted by geometrical projection. (more)

	Attribute	Type	Method	Documentation
P	bottomRightCorner	Vector3f	setBottomRightCorner	Set the bottom right corner of the projection.
P	bufferHeight	int	setBufferHeight	Sets the resolution of the intermediate buffer, in pixels.
P	bufferWidth	int	setBufferWidth	Sets the resolution of the intermediate buffer, in pixels.
P	clipAngles	angle4	setClipAngles	Angles between forward direction and the clip planes left, right, bottom and top, in radians.
P	extrinsics	float12	setExtrinsics	Set the position and orientation of the projection as an extrinsics matrix (12 values, 4 column 3-vectors, row major):
C	geometry	Geometry	setGeometry	Set the geometry to use for projection correction.
P	intrinsics	float4	setIntrinsics	Set the projection shape, as intrinsics (fx fy cx cy), in unitless values assuming a sensor size of 1x1.
P	linearInterpolation	bool	setLinearInterpolation	Turn on or off linear interpolation in the projection from linear graphics to non-linear projection space.
P	orientation	Quaternionf	setOrientation	Set orientation of the projection, of the extrinsics.
P	position	Vector3f	setPosition	Set the position of the optic center of the projection.
P	topLeftCorner	Vector3f	setTopLeftCorner	Set the top left corner of the projection.

Group

The scenegraph group base. (more)

	Attribute	Type	Method	Documentation
C	node	Node	addNode	Adds a child.

InterlaceMultiplexer

Interlaced stereoscopic multiplexer. (more)

	Attribute	Type	Method	Documentation
P	pattern	int	setPattern	Sets the interlace pattern between horizontal lines (0), vertical lines (1) and checkerboard pattern (2).

LinearAnaglyphsMultiplexer

An implementation of anaglyphs stereoscopic multiplexing that is based on linear operations. (more)

	Attribute	Type	Method	Documentation
P	leftColor	float3	setLeftColor	Sets the color of the left eye filter, in RGB 0-1.
P	leftSaturation	float	setLeftSaturation	Sets the saturation of color to use for the left eye, in the range 0-1.
P	rightColor	float3	setRightColor	Sets the color of the right eye filter, in RGB 0-1.
P	rightSaturation	float	setRightSaturation	Sets the saturation of color to use for the right eye, in the range 0-1.
P	saturation	float	setSaturation	Sets the saturation of color to use in the final image, in the range 0-1.

MatrixTransform (extends Group)

The scenegraph MatrixTransform base. (more)

	Attribute	Type	Method	Documentation
P	matrix	Matrix4f	setMatrix	Set the matrix of the childrens' space.

MultiscopicTextureMultiplexer

Texture that returns one other texture at a time that encodes multiple textures, typically for stereoscopic transcoding. (more)

	Attribute	Type	Method	Documentation
C	texture	TextureInterface	addTexture	Adds a texture to the set of multiscopic textures.

MultiscopicTextureSplitter

Texture that reads off one part at a time from another texture that encodes multiple textures, typically for stereoscopic transcoding. (more)

	Attribute	Type	Method	Documentation
C	texture	TextureInterface	setTexture	Set the texture to split.

MultiscopicView

The base of Views that support multiscopic perspectives. (more)

	Attribute	Type	Method	Documentation
C	multiscopicMultiplexer	MultiscopicMultiplexer	setMultiscopicMultiplexer	Sets the multiscopic multiplexing to use for rendering.

PlaneGeometry (extends Geometry)

PlaneGeometry contains information for projection of graphics on a plane. (more)

	Attribute	Type	Method	Documentation
P	normal	Vector3f	setNormal	Set the orientation of the plane by defining its normal.
P	orientation	Quaternionf	setOrientation	Set the orientation of the plane.
P	position	Vector3f	setPosition	Set the position of the plane.

PoseTransform (extends Group)

The scenegraph PoseTransform base. (more)

	Attribute	Type	Method	Documentation
P	orientation	Quaternionf	setOrientation	Set the orientation of the childrens' space.
P	orientationCenter	Vector3f	setOrientationCenter	Set the center of the orientation change.
P	position	Vector3f	setPosition	Set the position of the childrens' space.
P	scale	Vector3f	setScale	Set the scale of the childrens' space.
P	scaleCenter	Vector3f	setScaleCenter	Set the center of the scale change.
P	scaleOrientation	Quaternionf	setScaleOrientation	Set the orientation of the scale vector, in local space.

PosedPlanarView (extends View)

This view provides a projection of the renderers using the specified frustum projection from the viewpoint's point of view. (more)

	Attribute	Type	Method	Documentation
P	fieldOfView	angle2	setFieldOfView	Sets the horizontal and vertical field of view, in radians.

PosedSphericalView (extends View)

This view provides a symmetrical projection of the renderers, on a spherical projection surface. (more)

	Attribute	Type	Method	Documentation
C	coordinatesMapper	CoordinatesMapper	setCoordinatesMapper	Sets the coordinates mapper that should be used to map the 3D surrounding into the 2D view.
P	cubeMapResolution	int	setCubeMapResolution	Sets the resolution of the intermediate cube map, in pixels.
P	linearInterpolation	bool	setLinearInterpolation	Turn on or off linear interpolation in the projection from linear graphics to non-linear projection space.
P	makeSquare	bool	setMakeSquare	When set to true, the output on the view will be square, so that using a fisheye mapper would render the view as a circle instead of an ellipse.

RectilinearCameraModel

Coordinates mapper that compensates for the optical effects as described by a rectilinear camera model. (more)

	Attribute	Type	Method	Documentation
P	focalDistance	float2	setFocalDistance	Set the focal distance (fx fy) for the camera model, expressed relative to the image size.
P	focalOffset	float2	setFocalOffset	Set the focal offset (cx cy) for the camera model, expressed relative to the image size.
P	kDistortion	float3	setKDistortion	Set the k distortion parameters (k1 k2 k3).
P	pDistortion	float2	setPDistortion	Set the p distortion parameters (p1 p2).

RemapperView (extends View)

The RemapperView remaps another view from the mapping expressed by one CoordinatesMapper into the mapping expressed by another, in a single step. (more)

	Attribute	Type	Method	Documentation
C	from	CoordinatesMapper	setFrom	Sets the mapper to remap from, describing the mapping of the source, the input.
P	orientation	angle2	setOrientation	Sets an orientation offset for the remapping.
P	sphereRadius	float	setSphereRadius	Sets a sphere radius for the remapping.
C	to	CoordinatesMapper	setTo	Sets the mapper to remap to, describing the mapping of the target, the result.
C	view	View	addView	Adds a view to mask with chroma key.
P	viewOffset	float	setViewOffset	Sets an offset for the view position.

Renderer

The base of graphics Renderer implementations. (more)

	Attribute	Type	Method	Documentation
P	eye	Eye	addEye	Add an eye to render to.

SideBySideMultiplexer

Side-by-side stereoscopic multiplexing implementation. (more)

	Attribute	Type	Method	Documentation
P	pattern	int	setPattern	Sets the side-by-side pattern between horizontal (0), vertical (1) and frame packing (2).

SpatialPlanarView (extends MultiscopicView)

This view provides skewed frustum projection of the renderers, on a planar projection surface. (more)

	Attribute	Type	Method	Documentation
P	bottomRightCorner	Vector3f	setBottomRightCorner	Position of bottom right corner of the view.
P	clipAngles	angle4	setClipAngles	Set the clip angles of a virtual frustum, as left, right, bottom, top.
P	distance	float	setDistance	Set the orientation of a virtual frustum.
P	orientation	Quaternionf	setOrientation	Set the orientation of a virtual frustum.
P	position	Vector3f	setPosition	Set the position of a virtual frustum.
P	topLeftCorner	Vector3f	setTopLeftCorner	Position of the top left corner of the view.
P	upDirection	Vector3f	setUpDirection	Set up direction of the view.

SpatialSphericalView (extends MultiscopicView)

This view provides skewed frustum projection of the renderers, on a spherical projection surface. (more)

	Attribute	Type	Method	Documentation
C	coordinatesMapper	CoordinatesMapper	setCoordinatesMapper	Sets the coordinates mapper that should be used to map the 3D surrounding into the 2D view.
P	cubeMapResolution	int	setCubeMapResolution	Sets the resolution of the intermediate cube map, in pixels.
P	linearInterpolation	bool	setLinearInterpolation	Turn on or off linear interpolation in the projection from linear graphics to non-linear projection space.
P	makeSquare	bool	setMakeSquare	When set to true, the output on the view will be square, so that using a fisheye mapper would render the view as a circle instead of an ellipse.
P	orientation	Quaternionf	setOrientation	Set the orientation of the projection, for example to create a forward tilt common in dome theaters.
P	position	Vector3f	setPosition	Sets the location of the center of the spherical projection surface, in meters.
P	radius	float	setRadius	Set the radius of the projection surface, in meters.

SphereGeometry (extends Geometry)

SphereGeometry contains information for projection of graphics on a sphere. (more)

	Attribute	Type	Method	Documentation
P	frustumSizeRatio	float	setFrustumSizeRatio	Until the render frustum estimation has been implemented to correctly cover the full view frustum, this frustum size modulation parameter can be used to enlarge the render frustum.
P	position	Vector3f	setPosition	Set the position of the sphere origin, its center.
P	radius	float	setRadius	Set the radius of the sphere.

SphereRenderer (extends Renderer)

A renderer that draws single textured sphere. (more)

	Attribute	Type	Method	Documentation
C	coordinatesMapper	CoordinatesMapper	setCoordinatesMapper	Sets the coordinates mapper that should be used to map the 2D texture onto the 3D sphere.
P	radius	float	setRadius	Set the radius of the sphere.
C	texture	TextureInterface	setTexture	Sets the Texture to apply on the sphere.

SphereSceneRenderer (extends Renderer)

A renderer that draws a set of spheres, for demonstration and testing purposes. (more)

	Attribute	Type	Method	Documentation
P	color	Vector3f	setColor	Sets the color of the spheres in the set.
P	fillRatio	float	setFillRatio	Sets how large portion (approximately) of the space that should be covered by spheres.
P	sphereRadius	float	setSphereRadius	Sets the radius of each sphere to be drawn.
P	sphereSetRadius	float	setSphereSetRadius	Sets the radius of the set of spheres.

StereographicCoordinatesMapper

Coordinates mapper that provides a stereographic mapping between 2D and 3D. (more)

	Attribute	Type	Method	Documentation
P	coverageAngle	angle	setCoverageAngle	Calculates and sets the radius of the stereographic sphere from the specified angle the projection from -1 to 1 should cover on the sphere.
P	phi0	angle	setPhi0	Sets the pitch, the vertical heading, a value in the range -π/2 to π/2.
P	radius	float	setRadius	Sets the radius of the stereographic sphere.
P	theta0	angle	setTheta0	Sets the yaw, the horizontal heading, a value in the range 0 to 2π.

TextureProjectedView (extends MultiscopicView)

The TextureProjectedView uses a texture to define the 3D position of each render target buffer pixel, and then projects the specified renderers onto this "surface", from the viewpoint. (more)

	Attribute	Type	Method	Documentation
P	bufferWidth	size2	setBufferResolution	Sets the resolution of the intermediate buffer, in pixels.
P	linearInterpolation	bool	setLinearInterpolation	Turn on or off linear interpolation in the projection from linear graphics to non-linear projection space.
C	texture	TextureInterface	setTexture	Sets the Texture to use for warping coordinates.
P	warpOffset	Vector3f	setWarpOffset	Sets an offset to add to the texture values, so that the 3D position is calculated by p' = p * scale + offset.
P	warpScale	Vector3f	setWarpScale	Sets a scaling to the texture values, so that the 3D position is calculated by p' = p * scale + offset.

TextureRenderer (extends Renderer)

A renderer that renders a texture flat (2D) filling the view, thereby ignoring camera and view specific projection. (more)

	Attribute	Type	Method	Documentation
P	flip	bool	setFlip	Flip the image up-down for upside-down textures.
C	texture	TextureInterface	setTexture	Sets the Texture that should be called upon calls to the render method.

TextureWarpedView (extends View)

The TextureWarpedView uses a texture as 0-1 coordinates to warp the output from other views. (more)

	Attribute	Type	Method	Documentation
P	edgeToEdge	bool	setEdgeToEdge	De/activates edge-to-edge mode.
C	texture	TextureInterface	setTexture	Sets the Texture to use for warping coordinates.
C	view	View	addView	Adds a view to warp.
P	warpOffset	Vector2f	setWarpOffset	Sets an offset to add to the texture values, to reach outside of the texture.
P	warpScale	Vector2f	setWarpScale	Sets a scaling to the texture values to reach outside of the texture.

TiledView (extends View)

The TiledView tiles up a view into sub tiles each containing a separate View. (more)

	Attribute	Type	Method	Documentation
P	tileLocation	size4	addTileLocation	Adds a location and span that is used when adding views.
C	view	View	addView	Adds a view to the previously specified tile location.

TrackedTransform (extends Group)

The scenegraph TrackedTransform base. (more)

	Attribute	Type	Method	Documentation
P	hysteresis	float	setHysteresis	Sets the time, in seconds, a tracker lingers after ceasing to update their data, before it's removed.
C	multiPoseTracker	MultiPoseTracker	addMultiPoseTracker
C	singlePoseTracker	SinglePoseTracker	addSinglePoseTracker

TrackedViewpoint (extends Viewpoint)

The TrackedViewpoint is a Viewpoint that uses a SinglePoseTracker to updates its pose. (more)

	Attribute	Type	Method	Documentation
C	singlePoseTracker	SinglePoseTracker	setSinglePoseTracker

TransitionCoordinatesMapper

Coordinates mapper that provides a transition between two other coordinates mappers. (more)

	Attribute	Type	Method	Documentation
C	coordinatesMapper	CoordinatesMapper	addCoordinatesMapper	Adds a coordinates mapper that should be used to map the 3D surrounding into the 2D view.
P	frameRange	size2	setFrameRange	Set the start and end frame at which the transition should be made.
P	ratio	float	setRatio	Set a static ratio of interpolation between the two mappers.
P	timeRange	float2	setTimeRange	Set the start and end time at which the transition should be made.

VelocityViewpoint (extends Viewpoint)

The VelocityViewpoint animates the viewpoint position and orientation based on specified linear and angular velocities, respectively. (more)

	Attribute	Type	Method	Documentation
P	rotation	Quaternionf	setRotation	Sets the rotational velocity of the viewpoint, in rotation per second.
P	velocity	Vector3f	setVelocity	Sets the linear (position) velocity of the viewpoint, in meters per second.

ViewBase

The common base for nodes taking renderers for dispatching rendering jobs. (more)

	Attribute	Type	Method	Documentation
C	node	Node	addNode	Adds a scenegraph to the view.
C	viewpoint	Viewpoint	addViewpoint	Adds a viewpoint to use in the views rendered by this ViewBase.

ViewMixView (extends View)

This view mixes the graphics from two or more other views. (more)

	Attribute	Type	Method	Documentation
P	mixType	string	setMixType	Set type of mixing.
C	view	View	addView	Add a view to mix.

Viewpoint

The viewpoint represents a point in space from which the view is to be rendered, and an orientation. (more)

	Attribute	Type	Method	Documentation
P	eyeSeparation	float	setEyeSeparation	Sets the distance between the eyes for stereoscopic (or multiscopic) rendering, in internal units, typically meters.
P	lookAt	Vector3f	setLookAt	Sets a point that the viewpoint should be rotated towards.
P	orientation	Quaternionf	setOrientation	Explicitly sets the orientation of the Viewpoint.
P	position	Vector3f	setPosition	Explicitly sets the position of the Viewpoint.
P	upDirection	Vector3f	setUpDirection	Set the up direction to be used in a later call to setLookAt.

Window

The base of graphics Window implementations. (more)

	Attribute	Type	Method	Documentation
P	backgroundColor	float4	setBackgroundColor	Set the background color of the window.
P	fullscreen	bool	setFullscreen	Activates or deactivates fullscreen mode.
P	position	int2	setPosition	Sets the position of the window.
P	size	size2	setSize	Sets the size of the drawable canvas of this window, in pixels.
P	title	string	setTitle	Sets the title of the windows.
C	view	View	addView	Adds a view to the window.

YuvDecodeTexture

Decoder of Yuv encoded texture into a new texture. (more)

	Attribute	Type	Method	Documentation
C	texture	Texture	setTexture	Sets the texture to decode.
P	uvRange	float2	setUvRange	Sets the range of the UV values.
P	yuvToRgb	Matrix3f	setYuvToRgb	Sets the conversion matrix from YUV space to RGB.