From 41894f89f96341393fa8aff2a395b3ff5264c67a Mon Sep 17 00:00:00 2001 From: Laszlo Agocs Date: Tue, 15 May 2018 16:38:32 +0200 Subject: Update the attribute names table Task-number: QT3DS-1638 Change-Id: I9534b683b4ee766f9eba2d5da1efbb4fc8a6fffe Reviewed-by: Andy Nichols --- src/runtime/doc/src/attributenames.html | 212 ++------------------------------ src/runtime/doc/src/attributenames.qdoc | 31 ++++- 2 files changed, 38 insertions(+), 205 deletions(-) diff --git a/src/runtime/doc/src/attributenames.html b/src/runtime/doc/src/attributenames.html index 35212f7..422c617 100644 --- a/src/runtime/doc/src/attributenames.html +++ b/src/runtime/doc/src/attributenames.html @@ -6,45 +6,26 @@ Name name string - -always "Scene" - - - - -path -string - -always "Scene" - Enable Background Color bgcolorenable boolean - - Background Color R backgroundcolor.r number - - Background Color G backgroundcolor.g number - - Background Color B backgroundcolor.b number - - Elements other than Scenes @@ -52,31 +33,18 @@ always "Scene" Element Name name string - -always available - - - - -path -string - -full path to the element - (Eyeball) eyeball boolean - - Timebar Start starttime number -in integer milliseconds; always available +in integer milliseconds @@ -84,7 +52,7 @@ in integer milliseconds; always available endtime number -in integer milliseconds; always available +in integer milliseconds @@ -93,8 +61,6 @@ in integer milliseconds; always available Disable Depth Test disabledepthtest boolean - - Progressive AA @@ -116,8 +82,6 @@ values: 'None', '2x', '4x' Temporal AA temporalaa boolean - - Layer Background @@ -131,21 +95,23 @@ values: 'Transparent', 'Unspecified', 'SolidColo Background Color R backgroundcolor.r number - - Background Color G backgroundcolor.g number - - Background Color B backgroundcolor.b number + + +Blend Type +blendtype +string +values: 'Normal', 'Screen', 'Multiply', 'Add', '*Overlay', '*ColorBurn', '*ColorDodge' @@ -160,8 +126,6 @@ values: 'Left/Width', 'Left/Right', 'Width/Right Left left number - - Left Units @@ -175,8 +139,6 @@ values: 'pixels', 'percent' Width width number - - Width Units @@ -190,8 +152,6 @@ values: 'pixels', 'percent' Right right number - - Right Units @@ -213,8 +173,6 @@ values: 'Top/Height', 'Top/Bottom', 'Height/Bott Top top number - - Top Units @@ -228,8 +186,6 @@ values: 'pixels', 'percent' Height height number - - Height Units @@ -243,8 +199,6 @@ values: 'pixels', 'percent' Bottom bottom number - - Bottom Units @@ -266,71 +220,51 @@ values between 0 and 100 AO Distance aodistance number - - AO Softness aosoftness number - - AO Threshold aobias number - - AO Sampling Rate aosamplerate number - - AO Dithering aodither boolean - - Shadow Strength shadowstrength number - - Shadow Distance shadowdist number - - Shadow Softness shadowsoftness number - - Shadow Threshold shadowbias number - - Light Probe lightprobe image element - - IBL Horizon Cutoff @@ -354,92 +288,66 @@ id of the sub-presentation to display Position X position.x number - - Position Y position.y number - - Position Z position.z number - - Rotation X rotation.x number - - Rotation Y rotation.y number - - Rotation Z rotation.z number - - Scale X scale.x number - - Scale Y scale.y number - - Scale Z scale.z number - - Pivot X pivot.x number - - Pivot Y pivot.y number - - Pivot Z pivot.z number - - Opacity opacity number - - @@ -462,7 +370,7 @@ values: 'XYZ', 'YZX', 'ZXY', 'XZY'< ignoresparent boolean -prevents parent transformation from being applied +prevents parent transformation from being applied [ignored as of 2.0] @@ -481,29 +389,21 @@ relative or absolute element path Orthographic orthographic boolean - - Field of View fov number - - Clipping Start clipnear number - - Clipping End clipfar number - - Runtime Scale Mode @@ -543,64 +443,46 @@ values: 'Directional', 'Point', 'Area' Light Color R lightdiffuse.r number - - Light Color G lightdiffuse.g number - - Light Color B lightdiffuse.b number - - Specular Color R lightspecular.r number - - Specular Color G lightspecular.g number - - Specular Color B lightspecular.b number - - Ambient Color R lightambient.r number - - Ambient Color G lightambient.g number - - Ambient Color B lightambient.b number - - Brightness @@ -630,22 +512,16 @@ only applies to point lights Cast Shadows? castshadow boolean - - Shadow Darkness shdwfactor number - - Shadow Softness shdwfilter number - - Shadow Resolution @@ -659,21 +535,15 @@ values: '256', '512', '1024', '2048 Shadow Depth Bias shdwbias number - - Shadow Far Clip shdwmapfar number - - Shadow Field of View shdwmapfov number - - Groups @@ -681,8 +551,6 @@ values: '256', '512', '1024', '2048 Import sourcepath string - - Text @@ -690,43 +558,31 @@ values: '256', '512', '1024', '2048 Text String textstring string - - Text Color R textcolor.r number - - Text Color G textcolor.g number - - Text Color B textcolor.b number - - Font font string - - Font Size size number - - Horizontal Alignment @@ -748,15 +604,11 @@ values: 'Top', 'Middle', 'Bottom' Leading leading number - - Tracking tracking number - - Models @@ -764,15 +616,13 @@ values: 'Top', 'Middle', 'Bottom' Mesh sourcepath string - - Tessellation Mode tessellation string -values: 'None', 'Linear', 'Phong', 'NPatch' +values: 'None', 'Linear', 'Phong', 'NPatch' [ignored as of 2.0] @@ -780,6 +630,7 @@ values: 'None', 'Linear', 'Phong', edgetess number +[ignored as of 2.0] @@ -787,6 +638,7 @@ values: 'None', 'Linear', 'Phong', innertess number +[ignored as of 2.0] @@ -811,22 +663,16 @@ values: 'Normal', 'Screen', 'Multiply' Diffuse Color R diffuse.r number - - Diffuse Color G diffuse.g number - - Diffuse Color B diffuse.b number - - Diffuse Map @@ -864,29 +710,21 @@ to change the image set the sourcepath attribute on the image eleme Specular Tint R speculartint.r number - - Specular Tint G speculartint.g number - - Specular Tint B speculartint.b number - - Specular Amount specularamount number - - Specular Map @@ -908,22 +746,16 @@ values: 'Default', 'KGGX', 'KWard' Fresnel Power fresnelPower number - - Index of Refraction ior number - - Specular Roughness specularroughness number - - Bump Map @@ -961,15 +793,11 @@ to change the image set the sourcepath attribute on the image eleme Displacement Amount displaceamount number - - Opacity opacity number - - Opacity Map @@ -983,8 +811,6 @@ to change the image set the sourcepath attribute on the image eleme Emissive Power emissivepower number - - Emissive Map @@ -1010,15 +836,11 @@ relative or absolute element path U Repeat scaleu number - - V Repeat scalev number - - Texture Mapping @@ -1048,36 +870,26 @@ values: 'Tiled', 'Mirrored', 'No Tiling' UV Rotation rotationuv number - - U Position positionu number - - V Position positionv number - - U Pivot pivotu number - - V Pivot pivotv number - - Sub-Presentation diff --git a/src/runtime/doc/src/attributenames.qdoc b/src/runtime/doc/src/attributenames.qdoc index ac24645..2392149 100644 --- a/src/runtime/doc/src/attributenames.qdoc +++ b/src/runtime/doc/src/attributenames.qdoc @@ -1,4 +1,4 @@ -/**************************************************************************** +!/**************************************************************************** ** ** Copyright (C) 1993-2009 NVIDIA Corporation. ** Copyright (C) 2018 The Qt Company Ltd. @@ -26,9 +26,8 @@ ** ****************************************************************************/ -// This is a wrapper for getting script-generated -// content in attributenames.html into qdoc. -// (note: hand edited for 2.0) +// Pull in attributenames.html into qdoc. Note that attributenames.html is +// manually maintained since 2.0 and is not auto-generated. /*! \page qt3d-runtime-attribute-names.html @@ -36,7 +35,29 @@ \keyword Attributes Below is a list of the attributes that can be set on the various scene - objects via Q3DSPresentation::setAttribute() or Q3DSElement::setAttribute(): + objects via Q3DSPresentation::setAttribute() or Q3DSElement::setAttribute(). + + \note vector (e.g. a group's or model's \c rotation) and color (e.g. a + material's \c diffuse) attributes allow setting/getting all components in + one operation, and are mapped to QVector3D and QColor, respectively. + + \note As of Qt 3D Studio 2.0 not all properties can be changed on the fly at + run time. As a general rule attributes that are animatable in the Qt 3D + Studio application are freely changeable by the applications during run time + as well. \include attributenames.html + + Custom materials and effects have their custom set of properties that are + defined in the \c{.material} or \c{.effect} file. For example, an instances + of an effect with the following metadata will have an attribute \c HBlurBias + with the type \c number that can be set and queried as if it was a built-in + attribute. + + \badcode + + + + ... + \endcode */ -- cgit v1.2.3