QCustom3DVolume Class

The QCustom3DVolume class adds a volume rendered object to a graph. 更多...

头：	#include <QCustom3DVolume>
CMake:	find_package(Qt6 REQUIRED COMPONENTS DataVisualization) target_link_libraries(mytarget PRIVATE Qt6::DataVisualization)
qmake:	QT += datavisualization
Since:	QtDataVisualization 1.2
实例化：	Custom3DVolume
继承：	QCustom3DItem

所有成员列表，包括继承成员

特性

alphaMultiplier : float
colorTable : QList<QRgb>
drawSliceFrames : bool
drawSlices : bool
preserveOpacity : bool
sliceFrameColor : QColor
sliceFrameGaps : QVector3D
sliceFrameThicknesses : QVector3D
sliceFrameWidths : QVector3D

sliceIndexX : int
sliceIndexY : int
sliceIndexZ : int
textureData : QList<uchar>*
textureDepth : int
textureHeight : int
textureWidth : int
useHighDefShader : bool

公共函数

	QCustom3DVolume (QObject * parent = nullptr)
	QCustom3DVolume (const QVector3D & position , const QVector3D & scaling , const QQuaternion & rotation , int textureWidth , int textureHeight , int textureDepth , QList<uchar> * textureData , QImage::Format textureFormat , const QList<QRgb> & colorTable , QObject * parent = nullptr)
virtual	~QCustom3DVolume ()
float	alphaMultiplier () const
QList<QRgb>	colorTable () const
QList<uchar> *	createTextureData (const QList<QImage > & images* )
bool	drawSliceFrames () const
bool	drawSlices () const
bool	preserveOpacity () const
QImage	renderSlice (Qt::Axis axis , int index )
void	setAlphaMultiplier (float mult )
void	setColorTable (const QList<QRgb> & colors )
void	setDrawSliceFrames (bool enable )
void	setDrawSlices (bool enable )
void	setPreserveOpacity (bool enable )
void	setSliceFrameColor (const QColor & color )
void	setSliceFrameGaps (const QVector3D & 值 )
void	setSliceFrameThicknesses (const QVector3D & 值 )
void	setSliceFrameWidths (const QVector3D & 值 )
void	setSliceIndexX (int value )
void	setSliceIndexY (int value )
void	setSliceIndexZ (int value )
void	setSliceIndices (int x , int y , int z )
void	setSubTextureData (Qt::Axis axis , int index , const uchar * data )
void	setSubTextureData (Qt::Axis axis , int index , const QImage & image )
void	setTextureData (QList<uchar> * data )
void	setTextureDepth (int value )
void	setTextureDimensions (int width , int height , int depth )
void	setTextureFormat (QImage::Format format )
void	setTextureHeight (int value )
void	setTextureWidth (int value )
void	setUseHighDefShader (bool enable )
QColor	sliceFrameColor () const
QVector3D	sliceFrameGaps () const
QVector3D	sliceFrameThicknesses () const
QVector3D	sliceFrameWidths () const
int	sliceIndexX () const
int	sliceIndexY () const
int	sliceIndexZ () const
QList<uchar> *	textureData () const
int	textureDataWidth () const
int	textureDepth () const
QImage::Format	textureFormat () const
int	textureHeight () const
int	textureWidth () const
bool	useHighDefShader () const

信号

void	alphaMultiplierChanged (float mult )
void	colorTableChanged ()
void	drawSliceFramesChanged (bool enabled )
void	drawSlicesChanged (bool enabled )
void	preserveOpacityChanged (bool enabled )
void	sliceFrameColorChanged (const QColor & color )
void	sliceFrameGapsChanged (const QVector3D & 值 )
void	sliceFrameThicknessesChanged (const QVector3D & 值 )
void	sliceFrameWidthsChanged (const QVector3D & 值 )
void	sliceIndexXChanged (int value )
void	sliceIndexYChanged (int value )
void	sliceIndexZChanged (int value )
void	textureDataChanged (QList<uchar> * data )
void	textureDepthChanged (int value )
void	textureFormatChanged (QImage::Format format )
void	textureHeightChanged (int value )
void	textureWidthChanged (int value )
void	useHighDefShaderChanged (bool enabled )

详细描述

A volume rendered object is a box with a 3D texture. Three slice planes are supported for the volume, one along each main axis of the volume.

Rendering volume objects is very performance intensive, especially when the volume is largely transparent, as the contents of the volume are ray-traced. The performance scales nearly linearly with the amount of pixels that the volume occupies on the screen, so showing the volume in a smaller view or limiting the zoom level of the graph are easy ways to improve performance. Similarly, the volume texture dimensions have a large impact on performance. If the frame rate is more important than pixel-perfect rendering of the volume contents, consider turning the high definition shader off by setting the useHighDefShader 特性到 false .

注意： Volumetric objects are only supported with orthographic projection.

注意： Volumetric objects utilize 3D textures, which are not supported in OpenGL ES2 environments.

另请参阅 QAbstract3DGraph::addCustomItem (), QAbstract3DGraph::orthoProjection ，和 useHighDefShader .

特性文档编制

alphaMultiplier : float

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 .

访问函数：

float	alphaMultiplier () const
void	setAlphaMultiplier (float mult )

通知程序信号：

void	alphaMultiplierChanged (float mult )

另请参阅 preserveOpacity and textureData .

colorTable : QList < QRgb >

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.

默认为 0 .

访问函数：

QList<QRgb>	colorTable () const
void	setColorTable (const QList<QRgb> & colors )

通知程序信号：

void	colorTableChanged ()

另请参阅 textureData , setTextureFormat ()，和 QImage::colorTable ().

drawSliceFrames : bool

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.

默认为 false .

访问函数：

bool	drawSliceFrames () const
void	setDrawSliceFrames (bool enable )

通知程序信号：

void	drawSliceFramesChanged (bool enabled )

另请参阅 sliceIndexX , sliceIndexY , sliceIndexZ , drawSlices ，和 renderSlice ().

drawSlices : bool

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 .

注意： The slices are always drawn along the item axes, so if the item is rotated, the slices are rotated as well.

访问函数：

bool	drawSlices () const
void	setDrawSlices (bool enable )

通知程序信号：

void	drawSlicesChanged (bool enabled )

另请参阅 sliceIndexX , sliceIndexY ，和 sliceIndexZ .

preserveOpacity : bool

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 .

访问函数：

bool	preserveOpacity () const
void	setPreserveOpacity (bool enable )

通知程序信号：

void	preserveOpacityChanged (bool enabled )

另请参阅 alphaMultiplier .

sliceFrameColor : QColor

This property holds the color of the slice frame.

Transparent slice frame color is not supported.

Defaults to black.

访问函数：

QColor	sliceFrameColor () const
void	setSliceFrameColor (const QColor & color )

通知程序信号：

void	sliceFrameColorChanged (const QColor & color )

另请参阅 drawSliceFrames .

sliceFrameGaps : QVector3D

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.

默认为 QVector3D(0.01, 0.01, 0.01) .

访问函数：

QVector3D	sliceFrameGaps () const
void	setSliceFrameGaps (const QVector3D & 值 )

通知程序信号：

void	sliceFrameGapsChanged (const QVector3D & 值 )

另请参阅 drawSliceFrames .

sliceFrameThicknesses : QVector3D

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.

默认为 QVector3D(0.01, 0.01, 0.01) .

访问函数：

QVector3D	sliceFrameThicknesses () const
void	setSliceFrameThicknesses (const QVector3D & 值 )

通知程序信号：

void	sliceFrameThicknessesChanged (const QVector3D & 值 )

另请参阅 drawSliceFrames .

sliceFrameWidths : QVector3D

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.

默认为 QVector3D(0.01, 0.01, 0.01) .

访问函数：

QVector3D	sliceFrameWidths () const
void	setSliceFrameWidths (const QVector3D & 值 )

通知程序信号：

void	sliceFrameWidthsChanged (const QVector3D & 值 )

另请参阅 drawSliceFrames .

sliceIndexX : int

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.

默认为 -1 .

访问函数：

int	sliceIndexX () const
void	setSliceIndexX (int value )

通知程序信号：

void	sliceIndexXChanged (int value )

另请参阅 textureData , drawSlices ，和 drawSliceFrames .

sliceIndexY : int

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.

默认为 -1 .

访问函数：

int	sliceIndexY () const
void	setSliceIndexY (int value )

通知程序信号：

void	sliceIndexYChanged (int value )

另请参阅 textureData , drawSlices ，和 drawSliceFrames .

sliceIndexZ : int

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.

默认为 -1 .

访问函数：

int	sliceIndexZ () const
void	setSliceIndexZ (int value )

通知程序信号：

void	sliceIndexZChanged (int value )

另请参阅 textureData , drawSlices ，和 drawSliceFrames .

textureData : QList < uchar >*

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.

注意： Each x-dimension line of the data needs to be 32-bit aligned. If textureFormat is QImage::Format_Indexed8 和 textureWidth value is not divisible by four, padding bytes might need to be added to each x-dimension line of the data 。 textureDataWidth () function returns the padded byte count. The padding bytes should indicate a fully transparent color to avoid rendering artifacts.

默认为 0 .

访问函数：

QList<uchar> *	textureData () const
void	setTextureData (QList<uchar> * data )

通知程序信号：

void	textureDataChanged (QList<uchar> * data )

另请参阅 colorTable , setTextureFormat (), setSubTextureData ()，和 textureDataWidth ().

textureDepth : int

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

默认为 0 .

注意： The textureData value may need to be resized or recreated if this value is changed. Defaults to 0 .

访问函数：

int	textureDepth () const
void	setTextureDepth (int value )

通知程序信号：

void	textureDepthChanged (int value )

另请参阅 textureData , textureWidth , textureHeight ，和 setTextureFormat ().

textureHeight : int

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

默认为 0 .

注意： The textureData value may need to be resized or recreated if this value is changed. Defaults to 0 .

访问函数：

int	textureHeight () const
void	setTextureHeight (int value )

通知程序信号：

void	textureHeightChanged (int value )

另请参阅 textureData , textureWidth , textureDepth ，和 setTextureFormat ().

textureWidth : int

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

默认为 0 .

注意： The textureData value may need to be resized or recreated if this value is changed. Defaults to 0 .

访问函数：

int	textureWidth () const
void	setTextureWidth (int value )

通知程序信号：

void	textureWidthChanged (int value )

另请参阅 textureData , textureHeight , textureDepth , setTextureFormat ()，和 textureDataWidth ().

useHighDefShader : bool

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.

注意： This value does not affect the level of detail when rendering the slices of the volume.

默认为 true .

访问函数：

bool	useHighDefShader () const
void	setUseHighDefShader (bool enable )

通知程序信号：

void	useHighDefShaderChanged (bool enabled )

另请参阅 renderSlice ().

成员函数文档编制

`[explicit]` QCustom3DVolume:: QCustom3DVolume ( QObject * parent = nullptr)

Constructs a custom 3D volume with the given parent .

`[explicit]` QCustom3DVolume:: QCustom3DVolume (const QVector3D & position , const QVector3D & scaling , const QQuaternion & rotation , int textureWidth , int textureHeight , int textureDepth , QList < uchar > * textureData , QImage::Format textureFormat , const QList < QRgb > & colorTable , QObject * parent = nullptr)

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

另请参阅 textureData , setTextureFormat ()，和 colorTable .

`[虚拟]` QCustom3DVolume:: ~QCustom3DVolume ()

Deletes the custom 3D volume.

QList < uchar > QCustom3DVolume:: createTextureData (const QList < QImage > & images )

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.

另请参阅 textureData , textureWidth , textureHeight , textureDepth ，和 setTextureFormat ().

QImage QCustom3DVolume:: renderSlice ( Qt::Axis axis , int index )

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.

另请参阅 setTextureFormat ().

void QCustom3DVolume:: setSliceIndices ( int x , int y , int z )

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

另请参阅 textureData .

void QCustom3DVolume:: setSubTextureData ( Qt::Axis axis , int index , const uchar * data )

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.

注意： Each x-dimension line of the data needs to be 32-bit aligned when targeting the y-axis or z-axis. If textureFormat is QImage::Format_Indexed8 和 textureWidth value is not divisible by four, padding bytes might need to be added to each x-dimension line of the data to properly align it. The padding bytes should indicate a fully transparent color to avoid rendering artifacts.

另请参阅 textureData and renderSlice ().

void QCustom3DVolume:: setSubTextureData ( Qt::Axis axis , int index , const QImage & image )

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.

注意： Each x-dimension line of the data needs to be 32-bit aligned when targeting the y-axis or z-axis. If textureFormat is QImage::Format_Indexed8 和 textureWidth value is not divisible by four, padding bytes might need to be added to each x-dimension line of the image to properly align it. The padding bytes should indicate a fully transparent color to avoid rendering artifacts. It is not guaranteed that QImage will do this automatically.

另请参阅 textureData and renderSlice ().

void QCustom3DVolume:: setTextureDimensions ( int width , int height , int depth )

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

另请参阅 textureData .

void QCustom3DVolume:: setTextureFormat ( QImage::Format format )

Sets the format of the textureData 特性到 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 .

另请参阅 textureFormat (), colorTable ，和 textureData .

int QCustom3DVolume:: textureDataWidth () const

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 .

QImage::Format QCustom3DVolume:: textureFormat () const

Returns the format of the textureData property value.

另请参阅 setTextureFormat ().

`[signal]` void QCustom3DVolume:: textureFormatChanged ( QImage::Format format )

此信号被发射当 format 的 textureData value changes.

另请参阅 setTextureFormat ().

QCustom3DVolume Class

特性

公共函数

信号

详细描述

特性文档编制

alphaMultiplier : float

colorTable : QList < QRgb >

drawSliceFrames : bool

drawSlices : bool

preserveOpacity : bool

sliceFrameColor : QColor

sliceFrameGaps : QVector3D

sliceFrameThicknesses : QVector3D

sliceFrameWidths : QVector3D

sliceIndexX : int

sliceIndexY : int

sliceIndexZ : int

textureData : QList < uchar >*

textureDepth : int

textureHeight : int

textureWidth : int

useHighDefShader : bool

成员函数文档编制

[explicit] QCustom3DVolume:: QCustom3DVolume ( QObject * parent = nullptr)

[虚拟] QCustom3DVolume:: ~QCustom3DVolume ()

QList < uchar > *QCustom3DVolume:: createTextureData (const QList < QImage *> & images )

QImage QCustom3DVolume:: renderSlice ( Qt::Axis axis , int index )

void QCustom3DVolume:: setSliceIndices ( int x , int y , int z )

void QCustom3DVolume:: setSubTextureData ( Qt::Axis axis , int index , const uchar * data )

void QCustom3DVolume:: setSubTextureData ( Qt::Axis axis , int index , const QImage & image )

void QCustom3DVolume:: setTextureDimensions ( int width , int height , int depth )

void QCustom3DVolume:: setTextureFormat ( QImage::Format format )

int QCustom3DVolume:: textureDataWidth () const

QImage::Format QCustom3DVolume:: textureFormat () const

[signal] void QCustom3DVolume:: textureFormatChanged ( QImage::Format format )

内容

`[explicit]` QCustom3DVolume:: QCustom3DVolume ( QObject * parent = nullptr)

`[虚拟]` QCustom3DVolume:: ~QCustom3DVolume ()

QList < uchar > QCustom3DVolume:: createTextureData (const QList < QImage > & images )

`[signal]` void QCustom3DVolume:: textureFormatChanged ( QImage::Format format )