QCustom3DVolume Class

See also QAbstract3DGraph::addCustomItem(), QAbstract3DGraph::orthoProjection, useHighDefShader

This property holds the value that the alpha value of every texel of the volume texture is multiplied with at the render time.

This property 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:

• float alphaMultiplier() const

• void setAlphaMultiplier(float mult)

Notifier signal:

• void alphaMultiplierChanged(float mult)

See Also▲

This property holds 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:

• <> colorTable() const

• void setColorTable(const <> &colors)

Notifier signal:

• void colorTableChanged()

See Also▲

This property holds whether slice frames are drawn around the volume.

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:

• bool drawSliceFrames() const

• void setDrawSliceFrames(bool enable)

Notifier signal:

• void drawSliceFramesChanged(bool enabled)

See Also▲

This property holds whether the specified slices are drawn instead of the full volume.

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.

Access functions:

• bool drawSlices() const

• void setDrawSlices(bool enable)

Notifier signal:

• void drawSlicesChanged(bool enabled)

See Also▲

This property holds whether the alpha multiplier is applied to all texels.

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:

• bool preserveOpacity() const

• void setPreserveOpacity(bool enable)

Notifier signal:

• void preserveOpacityChanged(bool enabled)

See Also▲

This property holds the color of the slice frame.

Transparent slice frame color is not supported.

Defaults to black.

Access functions:

• sliceFrameColor() const

• void setSliceFrameColor(const &color)

Notifier signal:

• void sliceFrameColorChanged(const &color)

See Also▲

This property holds the size of the 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:

• sliceFrameGaps() const

• void setSliceFrameGaps(const &values)

Notifier signal:

• void sliceFrameGapsChanged(const &values)

See Also▲

This property holds 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:

• sliceFrameThicknesses() const

• void setSliceFrameThicknesses(const &values)

Notifier signal:

• void sliceFrameThicknessesChanged(const &values)

See Also▲

This property holds the width 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:

• sliceFrameWidths() const

• void setSliceFrameWidths(const &values)

Notifier signal:

• void sliceFrameWidthsChanged(const &values)

See Also▲

This property holds 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:

• int sliceIndexX() const

• void setSliceIndexX(int value)

Notifier signal:

• void sliceIndexXChanged(int value)

See Also▲

This property holds 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:

• int sliceIndexY() const

• void setSliceIndexY(int value)

Notifier signal:

• void sliceIndexYChanged(int value)

See Also▲

This property holds 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:

• int sliceIndexZ() const

• void setSliceIndexZ(int value)

Notifier signal:

• void sliceIndexZChanged(int value)

See Also▲

This property holds 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 the textureDepth property. The data in each 2D texture 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 the 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.

Defaults to 0.

Access functions:

• <uchar> *textureData() const

• void setTextureData(<uchar> *data)

Notifier signal:

• void textureDataChanged(<uchar> *data)

See Also▲

This property holds the depth of the 3D texture defining the volume content in pixels.

Defaults to 0.

Access functions:

• int textureDepth() const

• void setTextureDepth(int value)

Notifier signal:

• void textureDepthChanged(int value)

See Also▲

This property holds the height of the 3D texture defining the volume content in pixels.

Defaults to 0.

Access functions:

• int textureHeight() const

• void setTextureHeight(int value)

Notifier signal:

• void textureHeightChanged(int value)

See Also▲

This property holds the width of the 3D texture defining the volume content in pixels.

Defaults to 0.

Access functions:

• int textureWidth() const

• void setTextureWidth(int value)

Notifier signal:

• void textureWidthChanged(int value)

See Also▲

This property holds whether a high or low definition shader is used to render the volume.

If this property value is true, a high definition shader is used. 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 a much higher frame rate. The low definition shader does not guarantee that every texel of the volume texture is sampled, so there may be flickering if the volume contains distinct thin features.

Defaults to true.

Access functions:

• bool useHighDefShader() const

• void setUseHighDefShader(bool enable)

Notifier signal:

• void useHighDefShaderChanged(bool enabled)

See Also▲

Constructs a custom 3D volume with the given parent.

Constructs a custom 3D volume with the given position, scaling, rotation, textureWidth, textureHeight, textureDepth, textureData, textureFormat, colorTable, and optional parent.

See Also▲

Deletes the custom 3D volume.

Creates a new texture data array from an array of images and sets it as textureData for this volume object. The texture dimensions are also set according to image and array dimensions. All of the images in the array must be the same size. If the images are not all in the QImage::Format_Indexed8 format, all texture data will be converted into the QImage::Format_ARGB32 format. If the images are in the QImage::Format_Indexed8 format, the colorTable value for the entire volume will be taken from the first image.

Returns a pointer to the newly created array.

See Also▲

Renders the slice specified by index along the axis specified by axis into an image. The texture format of this object is used.

Returns the rendered image of the slice, or a null image if an invalid index is specified.

See Also▲

A convenience function for setting all three slice indices (x, y, and z) at once.

See Also▲

Sets a single 2D subtexture of the 3D texture along the specified axis of the volume. The index parameter specifies the subtexture to set. The texture data must be in the format specified by the textureFormat property and have the size of the cross-section of the volume texture along the specified axis multiplied by the texture format color depth in bytes. The data is expected to be ordered similarly to the data in images produced by the renderSlice() method along the same axis.

See Also▲

Sets a single 2D subtexture of the 3D texture along the specified axis of the volume. The index parameter specifies the subtexture to set. The source image must be in the format specified by the textureFormat property if textureFormat is indexed. If textureFormat is QImage::Format_ARGB32, the image is converted to that format. The image must have the size of the cross-section of the volume texture along the specified axis. The orientation of the image should correspond to the orientation of the slice image produced by renderSlice() method along the same axis.

See Also▲

A convenience function for setting all three texture dimensions (width, height, and depth) at once.

See Also▲

Sets the format of the textureData property to format. Only two formats are supported currently: QImage::Format_Indexed8 and QImage::Format_ARGB32. If an indexed format is specified, colorTable must also be set. Defaults to QImage::Format_ARGB32.

See Also▲

Returns the actual texture data width. When the texture format is QImage::Format_Indexed8, this value equals textureWidth aligned to a 32-bit boundary. Otherwise, this value equals four times textureWidth.

Returns the format of the textureData property value.

See Also▲

This signal is emitted when the format of the textureData value changes.

See Also▲