QCustom3DVolume Class

Property Documentation

alphaMultiplier : float

The alpha value of every texel of the volume texture is multiplied with this value at the render time. This can be used to introduce uniform transparency to the volume. If preserveOpacity is true, only texels with at least some transparency to begin with are affected, and fully opaque texels are not affected. The value must not be negative. Defaults to 1.0f.

Access functions:

Notifier signal:

See also preserveOpacity and textureData.

colorTable : QVector<QRgb>

The array containing the colors for indexed texture formats. If the texture format is not indexed, this array is not used and can be empty.

Defaults to 0.

Access functions:

Notifier signal:

See also textureData, setTextureFormat(), and QImage::colorTable().

drawSliceFrames : bool

If this property value is true, the frames of slices indicated by slice index properties will be drawn around the volume. If it is false, no slice frames will be drawn. Drawing slice frames is independent of drawing slices, so you can show the full volume and still draw the slice frames around it. This is useful when using renderSlice() to display the slices outside the graph itself. Defaults to false.

Access functions:

Notifier signal:

See also sliceIndexX, sliceIndexY, sliceIndexZ, drawSlices, and renderSlice().

drawSlices : bool

If this property value is true, the slices indicated by slice index properties will be drawn instead of the full volume. If it is false, the full volume will always be drawn. Defaults to false.

Note: The slices are always drawn along the item axes, so if the item is rotated, the slices are rotated as well.

Access functions:

Notifier signal:

See also sliceIndexX, sliceIndexY, and sliceIndexZ.

preserveOpacity : bool

If this property value is true, alphaMultiplier is only applied to texels that already have some transparency. If it is false, the multiplier is applied to the alpha value of all texels. Defaults to true.

Access functions:

Notifier signal:

See also alphaMultiplier.

sliceFrameColor : QColor

Indicates the color of the slice frame. Transparent slice frame color is not supported.

Defaults to black.

Access functions:

Notifier signal:

See also drawSliceFrames.

sliceFrameGaps : QVector3D

Indicates the amount of air gap left between the volume itself and the frame in each dimension. The gap can be different on different dimensions. The values are fractions of the volume thickness in the same dimension. The values cannot be negative.

Defaults to QVector3D(0.01, 0.01, 0.01).

Access functions:

Notifier signal:

See also drawSliceFrames.

sliceFrameThicknesses : QVector3D

Indicates the thickness of the slice frames for each dimension. The values are fractions of the volume thickness in the same dimension. The values cannot be negative.

Defaults to QVector3D(0.01, 0.01, 0.01).

Access functions:

Notifier signal:

See also drawSliceFrames.

sliceFrameWidths : QVector3D

Indicates the widths of the slice frame. The width can be different on different dimensions, so you can for example omit drawing the frames on certain sides of the volume by setting the value for that dimension to zero. The values are fractions of the volume thickness in the same dimension. The values cannot be negative.

Defaults to QVector3D(0.01, 0.01, 0.01).

Access functions:

Notifier signal:

See also drawSliceFrames.

sliceIndexX : int

The X dimension index into the texture data indicating which vertical slice to show. Setting any dimension to negative indicates no slice or slice frame for that dimension is drawn. If all dimensions are negative, no slices or slice frames are drawn and the volume is drawn normally. Defaults to -1.

Access functions:

Notifier signal:

See also textureData, drawSlices, and drawSliceFrames.

sliceIndexY : int

The Y dimension index into the texture data indicating which horizontal slice to show. Setting any dimension to negative indicates no slice or slice frame for that dimension is drawn. If all dimensions are negative, no slices or slice frames are drawn and the volume is drawn normally. Defaults to -1.

Access functions:

Notifier signal:

See also textureData, drawSlices, and drawSliceFrames.

sliceIndexZ : int

The Z dimension index into the texture data indicating which vertical slice to show. Setting any dimension to negative indicates no slice or slice frame for that dimension is drawn. If all dimensions are negative, no slices or slice frames are drawn and the volume is drawn normally. Defaults to -1.

Access functions:

Notifier signal:

See also textureData, drawSlices, and drawSliceFrames.

textureData : QVector<uchar> *

The array containing the texture data in the format specified by textureFormat. The size of this array must be at least (textureDataWidth * textureHeight * textureDepth * texture format color depth in bytes).

A 3D texture is defined by a stack of 2D subtextures. Each subtexture must be of identical size (textureDataWidth * textureHeight), and the depth of the stack is defined by textureDepth property. Each 2D texture data is identical to a QImage data with the same format, so QImage::bits() can be used to supply the data for each subtexture.

Ownership of the new array transfers to QCustom3DVolume instance. If another array is set, the previous array is deleted. If the same array is set again, it is assumed that the array contents have been changed and the graph rendering is triggered.

Note: Each X-line of the data needs to be 32bit aligned. If the textureFormat is QImage::Format_Indexed8 and textureWidth is not divisible by four, padding bytes need to be added to each X-line of the data. You can get the padded byte count with textureDataWidth() function. The padding bytes should indicate an fully transparent color to avoid rendering artifacts.

Defaults to 0.

Access functions:

Notifier signal:

See also colorTable, setTextureFormat(), setSubTextureData(), and textureDataWidth().

textureDepth : int

The depth of the 3D texture defining the volume content in pixels. Defaults to 0.

Note: The textureData may need to be resized or recreated if this value is changed. Defaults to 0.

Access functions:

Notifier signal:

See also textureData, textureWidth, textureHeight, and setTextureFormat().

textureHeight : int

The height of the 3D texture defining the volume content in pixels. Defaults to 0.

Note: The textureData may need to be resized or recreated if this value is changed. Defaults to 0.

Access functions:

Notifier signal:

See also textureData, textureWidth, textureDepth, and setTextureFormat().

textureWidth : int

The width of the 3D texture defining the volume content in pixels. Defaults to 0.

Note: The textureData may need to be resized or recreated if this value is changed. Defaults to 0.

Access functions:

Notifier signal:

See also textureData, textureHeight, textureDepth, setTextureFormat(), and textureDataWidth().

useHighDefShader : bool

If this property value is true, a high definition shader is used to render the volume. If it is false, a low definition shader is used.

The high definition shader guarantees that every visible texel of the volume texture is sampled when the volume is rendered. The low definition shader renders only a rough approximation of the volume contents, but at much higher frame rate. The low definition shader doesn't guarantee every texel of the volume texture is sampled, so there may be flickering if the volume contains distinct thin features.

Note: This value doesn't affect the level of detail when rendering the slices of the volume.

Defaults to true.

Access functions:

Notifier signal:

See also renderSlice().