Documentation Center public:software:dazstudio:4:referenceguide:scripting:api_reference:object_index

Dz3DViewport

2022-05-24T21:42:37+00:00

Dz3DViewport

A widget for displaying and interacting with three dimensional objects.

Inherits :

QObject
- QWidget

Enumerations

DAZ Script
FloorStyle	{ NoFloor, WireFloor, SolidFloor }
ShadeStyle	{ WireBox, SolidBox, Wireframe, LitWireframe, HiddenLine, WireShaded, SmoothShaded, WireTextured, Textured }
ToolBarMode	{ DockedToolBar, CameraCubeHUD }

Properties

DAZ Script
Boolean	aspectOn
Boolean	axesOn
Color	background
FloorStyle	floorStyle
ShadeStyle	shadeStyle
Boolean	showPoseTool
Boolean	thirdsGuideOn
ToolBarMode	toolBarMode

Methods

DAZ Script
void	aimCamera ()
void	aimCameraAtBox ( DzBox3 box )
void	aimCameraAtPrimaryNode ()
Image	captureImage ()
DzInt2	currentDimensions ()
void	endNavigation ()
void	frameCamera ()
void	frameCameraOnBox ( DzBox3 box )
void	frameCameraOnSelectedNodes ()
Rect	getAspectFrameRect ()
DzCamera	getCamera ()
cameracube_dz	getCameraCube ()
DzDrawStyle	getDrawStyle ()
String	getUserDrawStyle ()
DzViewport	getViewport ()
Boolean	hardwareRender ( DzRenderHandler handler )
Boolean	hardwareRenderWithOptions ( DzRenderHandler handler, DzRenderOptions options, DzCamera camera=null, DzDrawStyle style=null )
Boolean	isHardwareRenderable ()
Boolean	isNavigating ()
Number	pickOnFacet ( Point pnt )
Number	pickOnGizmo ( Point pnt )
DzMaterial	pickOnMaterial ( Point pnt )
DzNode	pickOnNode ( Point pnt )
DzNode	pickOnNode ( Point pnt, Boolean useSelectionMaps )
Boolean	renderThumbnail ( DzRenderHandler handler )
void	resetCamera ()
void	setCamera ( String cam )
void	setCamera ( DzCamera cam )
void	setDrawStyle ( DzDrawStyle style )
Boolean	setUserDrawStyle ( String description )
Deprecated
Boolean	mouseIsDown ()

Signals

void	activeCameraChanged ( DzCamera cam )
void	activeCameraProjectionChanged ()
void	activeCameraTransformChanged ()
void	aspectOnChanged ( Boolean onOff )
void	axesOnChanged ( Boolean onOff )
void	backgroundColorChanged ( Color color )
void	contextMenuAboutToShow ( DzMenu menu, Point pos )
void	currentDimensionsChanged ()
void	dimensionsChanged ()
void	drawStyleChanged ( DzDrawStyle style )
void	floorStyleChanged ( FloorStyle style )
void	thirdsGuideOnChanged ( Boolean onOff )
void	toolBarDocked ( Boolean onOff )
void	toolModeChanged ( ToolBarMode mode )
void	viewChanged ()

Detailed Description

A Dz3DViewport is a widget for displaying three dimensional objects using OpenGL and interacting with those objects using DzViewTool subclasses.

See Also:

DzViewport::get3DViewport()

Enumerations

: FloorStyle

The styles of the floor that is drawn in the viewport.

NoFloor - No floor is drawn.
WireFloor - A grid floor is drawn.
SolidFloor - A solid floor is drawn. (not currently implemented)

—–

: ShadeStyle

A list of shading styles for rendering scene objects in OpenGL. These coincide with the ShadeStyle types in DzDrawStyle, and are provided here for script-ability.

WireBox - Draws unlit wire-frame bounding boxes.
SolidBox - Draws smooth-shaded bounding boxes.
Wireframe - Draws unlit wire-frames.
LitWireframe - Draws lit wire-frames.
HiddenLine - Draws unlit wire-frames, front geometry facing only.
WireShaded - Draws lit smooth shaded objects with wireframes imposed.
SmoothShaded - Draws lit smooth shaded objects.
WireTextured - Draws lit smooth shaded objects with any texture/transparency maps applied and wireframes imposed.
Textured - Draws lit smooth shaded objects with any texture/transparency maps applied.

—–

: ToolBarMode

The different toolbar modes for the interface.

DockedToolBar - A mode that docks the toolbar along the top edge of the viewport.
CameraCubeHUD - A mode that uses a Camera Cube HUD in the top right corner of the viewport.

Properties

Boolean : aspectOn

Holds whether or not the aspect frame is drawn in the viewport.

Boolean : axesOn

Holds whether or not the origin axes are drawn in the viewport.

Color : background

Holds the background color of the viewport

FloorStyle : floorStyle

Holds the style of the floor that is drawn in the viewport.

ShadeStyle : shadeStyle

Holds the shading style of the viewport.

Boolean : showPoseTool

Holds whether or not the Pose Tool is shown.

Boolean : thirdsGuideOn

Holds whether or not the thirds guide is drawn in the viewport.

Since:

4.6.3.12

ToolBarMode : toolBarMode

Holds the mode for the viewport display of toolbars/camera cube

Methods

void : aimCamera()

Aim the viewport's active camera at the selected nodes in the scene. If the scene does not have any select nodes, all nodes in the scene are aimed. Note that the viewport's active camera is excluded, as are any nodes that are parented to the viewport's active camera.

See Also:

Sample: Aim Camera

void : aimCameraAtBox( DzBox3 box )

Aim the viewport's active camera at the given box. If the box is invalid, this function does nothing.

Parameter(s):

box - The box to aim the viewport's active camera at.

See Also:

DzCamera::aimAt()

void : aimCameraAtPrimaryNode()

Image : captureImage()

Captures the current contents from the OpenGL frame buffer as an image.

Return Value:

A snap shot of the OpenGL frame buffer.

Example:

// If there is a main window
if( MainWindow ){
	// Get the active viewport
	var oViewportMgr = MainWindow.getViewportMgr();
	var oViewport = oViewportMgr.getActiveViewport().get3DViewport();
 
	// Capture the contents of the active viewport
	var oImg = oViewport.captureImage();
 
	// Get the image manager
	var oImgMgr = App.getImageMgr();
 
	// Save the image to a file
	oImgMgr.saveImage( String( "%1/viewport.png" ).arg( App.getDocumentsPath()) , oImg );
}

DzInt2 : currentDimensions()

Return Value:

The current dimensions of the viewport.

Since:

4.6.4.100

void : endNavigation()

Stops any camera operations that are currently active.

Since:

4.11.0.161

void : frameCamera()

Frame the viewport's active camera at the selected nodes in the scene. If the scene does not have any select nodes, all nodes in the scene are framed. Note that the viewport's active camera is excluded, as are any nodes that are parented to the viewport's active camera.

See Also:

Sample: Frame Camera

void : frameCameraOnBox( DzBox3 box )

Frame the viewport's active camera at the given box. If the box is invalid this function does nothing.

Parameter(s):

box - The box to frame the viewport's active camera on.

See Also:

DzCamera::frame()

void : frameCameraOnSelectedNodes()

Rect : getAspectFrameRect()

Return Value:

A rect describing the aspect frame for this viewport.

DzCamera : getCamera()

Return Value:

The currently active camera for this viewport.

Example:

// Get the active viewport
var oViewportMgr = MainWindow.getViewportMgr();
var oViewport = oViewportMgr.getActiveViewport().get3DViewport();
 
// Get the active camera
var oCamera = oViewport.getCamera();
// Reset the camera
oCamera.reset();

See Also:

Sample: Aim Camera
Sample: Frame Camera
setCamera()

cameracube_dz : getCameraCube()

Return Value:

The persistent Camera Cube view tool for this viewport; displayed when the toolBarMode is set to CameraCubeHUD.

Since:

4.9.3.107

DzDrawStyle : getDrawStyle()

Return Value:

The current drawstyle for the viewport.

Since:

4.14.1.27

String : getUserDrawStyle()

Return Value:

The description of the DrawStyle (if the current DrawStyle is a DzUserDrawStyle), otherwise an empty string.

Since:

4.9.2.22

DzViewport : getViewport()

Return Value:

This 3D view's parent viewport.

Boolean : hardwareRender( DzRenderHandler handler )

Performs a hardware assisted OpenGL render in this viewport with the given settings.

Parameter(s):

handler - The render handler for the rendering operation.

Return Value:

true if the scene was rendered successfully, otherwise false.

Boolean : hardwareRenderWithOptions( DzRenderHandler handler, DzRenderOptions options, DzCamera camera=null, DzDrawStyle style=null )

Performs a hardware assisted OpenGL render in this viewport with the given settings.

Parameter(s):

handler - The render handler for the rendering operation.
options - The render options to use. (since 4.9.3.61)
camera - The camera to render through, set to null to render from current view. (since 4.9.3.61)
style - The draw style to use, null to use standard render draw style. (since 4.9.3.61)

Return Value:

true if the scene was rendered successfully, otherwise false.

Since:

4.9.3.57

Boolean : isHardwareRenderable()

Return Value:

true if this viewport supports rendering via OpenGL, otherwise false.

Boolean : isNavigating()

Return Value:

true if a mouse operation is active, otherwise false.

Since:

4.11.0.161

Number : pickOnFacet( Point pnt )

Performs a facet picking operation on the scene through this viewport.

Parameter(s):

pnt - The pixel coordinates of the point in the viewport to pick on.

Return Value:

The index of the facet that was hit (if any), otherwise -1.

Number : pickOnGizmo( Point pnt )

Performs a gizmo picking operation through this viewport. View tools (see DzViewTool) can draw a 'gizmo' in the viewport for the user to interact with. The tool can assign different parts of the gizmo to specific indices, so as to tell what part of the gizmo was clicked by the user.

Parameter(s):

pnt - The point in the viewport to pick on.

Return Value:

The gizmo index that was hit (if any), otherwise 0.

DzMaterial : pickOnMaterial( Point pnt )

Performs a material picking operation on the scene through this viewport. This example shows the mousePress() implementation from a view tool (see DzViewTool) that sets the color of any material that the user clicks in the viewport.

Parameter(s):

pnt - The pixel coordinates of the point in the viewport to pick on.

Return Value:

The material that was hit (if any), otherwise null.

DzNode : pickOnNode( Point pnt )

Performs a node picking operation on the scene through this viewport.

Parameter(s):

pnt - The pixel coordinates of the point in the viewport to pick on.

Return Value:

The node that was hit (if any), otherwise null.

DzNode : pickOnNode( Point pnt, Boolean useSelectionMaps )

Performs a node picking operation on the scene through this viewport.

Parameter(s):

pnt - The pixel coordinates of the point in the viewport to pick on.
useSelectionMaps - If true, selection maps are used to perform the picking operation.

Return Value:

The node that was hit (if any), otherwise null.

Boolean : renderThumbnail( DzRenderHandler handler )

Performs a quick render of the scene suitable for a thumbnail image.

Parameter(s):

handler - The render handler for the rendering operation.

Return Value:

true if the scene was successfully rendered, otherwise false.

void : resetCamera()

Resets the viewport's active camera to its default state.

See Also:

DzCamera::reset()

void : setCamera( String cam )

Set the camera for the view. If a matching camera is not found, this function does nothing.

Parameter(s):

cam - The name (not label) of a view camera, or a scene camera.

void : setCamera( DzCamera cam )

Set the camera for the view. The camera passed in must be a camera in the scene, or one of the view cameras from DzViewportMgr.

Parameter(s):

cam - The camera to use for viewing in the viewport.

Example:

// Get the active viewport
var oViewportMgr = MainWindow.getViewportMgr();
var oViewport = oViewportMgr.getActiveViewport().get3DViewport();
 
// Create a new camera
var oCam = new DzBasicCamera( oCam.GENERAL_CAMERA );
oCam.setName( "Test Camera" );
 
// Add the camera to the scene
Scene.addNode( oCam );
 
// Set the active viewport to view through the new camera
oViewport.setCamera( oCam );

See Also:

getCamera()

void : setDrawStyle( DzDrawStyle style )

Set the draw style for the viewport. DzDrawStyle objects are ref counted, so the viewport refs the style when it is set, and unrefs it when it is no longer using the style. The draw style will then delete itself when its ref count reaches zero.

Parameter(s):

style - The new draw style for the viewport.

See Also:

Sample: Active Viewport DrawStyle

Boolean : setUserDrawStyle( String description )

Attempts to set the DrawStyle for the viewport.

Parameter(s):

description - The description of the DzUserDrawStyle to set.

Return Value:

true if a DzUserDrawStyle that matches the description could be found, otherwise false.

Since:

4.9.2.22

Boolean : mouseIsDown()

Deprecated

Exists only to keep old code working. Do not use in new code. Use isNavigating() instead.

Since:

4.6.4.20

Signals

void : activeCameraChanged( DzCamera cam )

Signature:“activeCameraChanged(DzCamera*)”

Emitted when a new active camera has been changed for this viewport.

Parameter(s):

cam - The new camera for this viewport.

void : activeCameraProjectionChanged()

Signature:“activeCameraProjectionChanged()”

Emitted when the projection of the active camera of this viewport has changed.

void : activeCameraTransformChanged()

Signature:“activeCameraTransformChanged()”

Emitted when the transform of the active camera of this viewport has changed.

void : aspectOnChanged( Boolean onOff )

Signature:“aspectOnChanged(bool)”

Emitted when the draw state for the aspect frame changes.

Parameter(s):

onOff - true if the aspect frame is displayed, otherwise false.

void : axesOnChanged( Boolean onOff )

Signature:“axesOnChanged(bool)”

Emitted when the draw state for the origin axes changes.

Parameter(s):

onOff - true if the origin axis is displayed, otherwise false.

void : backgroundColorChanged( Color color )

Signature:“backgroundColorChanged(const QColor&)”

Emitted when the background color of the viewport changes.

Parameter(s):

color - The new background color.

void : contextMenuAboutToShow( DzMenu menu, Point pos )

Signature:“contextMenuAboutToShow(DzMenu*,QPoint)”

Emitted when the viewport is about to display a context menu. Other objects can connect to this signal to add custom items to the menu that is displayed to the user. Only connect to this signal if you only want to affect this particular viewport - otherwise connect to DzViewportMgr::contextMenuAboutToShow().

Parameter(s):

menu - The menu that will be displayed.
pos - The position in the viewport where the context menu was triggered.

void : currentDimensionsChanged()

Signature:“currentDimensionsChanged()”

Emitted when the current dimensions of this viewport has changed.

void : dimensionsChanged()

Signature:“dimensionsChanged()”

Emitted when the dimensions of this viewport has changed.

void : drawStyleChanged( DzDrawStyle style )

Signature:“drawStyleChanged(DzDrawStyle*)”

Emitted when the draw style of the viewport has changed.

Parameter(s):

style - The new draw style of the viewport.

void : floorStyleChanged( FloorStyle style )

Signature:“floorStyleChanged(FloorStyle)”

Emitted when the floor style of the viewport changes.

Parameter(s):

style - The new floor style for the viewport.

void : thirdsGuideOnChanged( Boolean onOff )

Signature:“thirdsGuideOnChanged(bool)”

Emitted when the draw state for the thirds guide changes.

Parameter(s):

onOff - true if the thirds guide is displayed, otherwise false.

void : toolBarDocked( Boolean onOff )

Signature:“toolBarDocked(bool)”

Emitted when the view tool bar is docked or undocked.

Parameter(s):

onOff - true if the view tool bar is docked, otherwise false.

void : toolModeChanged( ToolBarMode mode )

Signature:“toolModeChanged(ToolBarMode)”

Emitted when the toolbar mode has been changed for this viewport.

Parameter(s):

mode - The new toolbar mode for this viewport.

void : viewChanged()

Signature:“viewChanged()”

Emitted when the area this viewport displays has changed.

Dz3DViewRenderHandler

2022-05-21T08:52:17+00:00

Dz3DViewRenderHandler

A render handler that renders into a viewport.

More...

Inherits :

QObject
- DzRenderHandler
  - DzImageRenderHandler

Constructors

DAZ Script
Dz3DViewRenderHandler ( DzViewport view, DzTime startTime, String filename )

Methods

DAZ Script
Number	getLeftOffset ()
Number	getTopOffset ()
renderview_dz	getView ()
DzViewport	getViewport ()

Detailed Description

This render handler is a DzImageRenderHandler that is the size of the aspect frame for the given viewport, and paints all data passed to it over the current view.

Constructors

Dz3DViewRenderHandler( DzViewport view, DzTime startTime, String filename )

Constructor. Creates a render handler that will render to the given viewport.

Parameter(s):

view - The viewport to render in.
startTime - The starting scene time for the render.
filename - The name of the file to save the render to.

Example:

// Get the active viewport and camera
var oActiveView = MainWindow.getViewportMgr().getActiveViewport();
var oCamera = oActiveView.get3DViewport().getCamera();
 
// Create a handler
var oHandler = new Dz3DViewRenderHandler( oActiveView, 0, App.getTempPath() + "/test.png" );
 
// If we have a valid handler
if( oHandler ){
	// Set the background color
	oHandler.setBackColor( oActiveView.get3DViewport().background );
 
	// Get the render options
	var oRenderOptions = App.getRenderOptions();
 
	// Get the renderer
	var oRenderer = oRenderOptions.getActiveRenderer();
 
	// Render, using our handler and options
	oRenderer.render( oHandler, oCamera, oRenderOptions );
}

Methods

Number : getLeftOffset()

Return Value:

The offset for this handler, from the left of the view.

Since:

4.6.4.18

Number : getTopOffset()

Return Value:

The offset for this handler, from the top of the view.

Since:

4.6.4.18

renderview_dz : getView()

Return Value:

The render view for this handler.

Since:

4.6.4.18

DzViewport : getViewport()

Return Value:

The viewport for this handler.

Since:

4.6.4.18

DzAbstractAssetContainer

2022-05-24T21:43:11+00:00

DzAbstractAssetContainer

Base class for all asset containers.

More...

Inherits :

Inherited By : DzCategoryAssetContainer, DzCompatibilityBaseAssetContainer, DzFolderAssetContainer, DzParentProductContainer, DzProductAssetContainer, DzTopLevelAssetContainer and DzTypeAssetContainer

Properties

DAZ Script
Boolean	canCopyContainers
Boolean	canDeleteContainer
Boolean	canInsertSubContainer
Boolean	canModifyAssets
Boolean	canRenameContainer
Object	id
Boolean	removeAssetCausesDelete
String	tooltip
Number	useCount

Methods

DAZ Script
Boolean	clearRebuildableAssets ()
Boolean	createNewChildContainer ( String containerName )
DzAsset	getAsset ( Number index )
Array	getAssets ()
DzAbstractAssetContainer	getChildContainer ( Number index )
Array	getChildContainers ()
Size	getChildIconSize ()
String	getContainerName ()
Array	getIDPath ()
Number	getNumAssets ()
Number	getNumChildContainers ()
DzAbstractAssetContainer	getOwner ()
Size	getSmallChildIconSize ()
String	getSupportFile ()
Boolean	hasAsset ( DzAsset asset )
Boolean	hasChildContainers ()
Boolean	ignoreAssetConflicts ()
Boolean	initChildren ()
Boolean	insertAsset ( DzAsset asset )
Boolean	insertChildContainer ( DzAbstractAssetContainer container )
Boolean	isFileSystemBased ()
Boolean	moveFromParent ( DzAbstractAssetContainer child )
Boolean	removeAsset ( DzAsset asset )
Boolean	removeAssetOnCut ( DzAbstractAssetContainer toContainer )
Boolean	removeChildContainer ( DzAbstractAssetContainer container )
Boolean	rename ( String name )
Boolean	renameAsset ( DzAsset asset, String newAssetName )
Boolean	renameChildContainer ( DzAbstractAssetContainer container, String name )
void	setContainerName ( String name )
Boolean	update ()
Boolean	updateAssets ()

Signals

void	assetIconChanged ( DzAsset asset )
void	assetRenamed ( DzAsset asset, Number index )
void	beginAssetAdd ( Number start, Number end )
void	beginAssetRemove ( Number start, Number end )
void	beginChildContainerAdd ( DzAbstractAssetContainer container, Number start, Number end )
void	beginChildContainerRemove ( DzAbstractAssetContainer container, Number start, Number end )
void	childContainerAboutToBeRemoved ( DzAbstractAssetContainer childContainer )
void	childContainerRemoved ( DzAbstractAssetContainer childContainer )
void	endAssetAdd ()
void	endAssetRemove ()
void	endChildContainerAdd ()
void	endChildContainerRemove ()
void	iconChanged ( DzAbstractAssetContainer container )

Detailed Description

TODO: Add detailed description.

Properties

Boolean : canCopyContainers

Holds whether or not sub-containers can be copied. (Read Only)

Boolean : canDeleteContainer

Holds whether or not this container can be deleted. (Read Only)

Boolean : canInsertSubContainer

Holds whether or not sub-containers can be added to this container. (Read Only)

Boolean : canModifyAssets

Holds whether or not the assets in this container can be modified. (Read Only)

Boolean : canRenameContainer

Holds whether or not this container can be renamed. (Read Only)

Object : id

Holds the id for this container. (Read Only)

Boolean : removeAssetCausesDelete

Holds whether or not removing an asset from this container will result in that asset's file being deleted. (Read Only)

Since:

4.11.0.193

String : tooltip

Holds the tooltip for this container. (Read Only)

Number : useCount

Holds the use count for this container.

Methods

Boolean : clearRebuildableAssets()

Attempts to clear out the assets that can be rebuilt.

Return Value:

The current implementation does nothing and always returns false

Boolean : createNewChildContainer( String containerName )

Attempts to create a new child container.

Parameter(s):

containerName - The name of the new child container.

Return Value:

true if the container was successfully created, otherwise false.

DzAsset : getAsset( Number index )

Parameter(s):

index - The index of the asset to be returned.

Return Value:

The asset at the specified index (if valid), otherwise null.

See Also:

DzScriptHandle

Array : getAssets()

Return Value:

A list of assets for this container.

See Also:

DzScriptHandle

DzAbstractAssetContainer : getChildContainer( Number index )

Parameter(s):

index - The index of the child container to get.

Return Value:

The child container at the given index (if valid), otherwise null.

See Also:

DzScriptHandle

Array : getChildContainers()

Return Value:

A list of child containers for this container.

See Also:

DzScriptHandle

Size : getChildIconSize()

Return Value:

The size of the icon associated with child containers.

String : getContainerName()

Return Value:

The name of this container.

Array : getIDPath()

Return Value:

The ID path for this container.

Number : getNumAssets()

Return Value:

The number of assets associated with this container.

Number : getNumChildContainers()

Return Value:

The number of child containers this container has.

DzAbstractAssetContainer : getOwner()

Return Value:

The owner of this container.

Size : getSmallChildIconSize()

Return Value:

The small icon size of the icon associated with child containers.

String : getSupportFile()

Return Value:

The support file for this asset container. Base implementation returns an empty string.

Boolean : hasAsset( DzAsset asset )

Parameter(s):

asset - The asset to check for.

Return Value:

true if this container has the given asset, otherwise false.

Boolean : hasChildContainers()

Return Value:

true if thic container has child containers, otherwise false.

Boolean : ignoreAssetConflicts()

Boolean DzAbstractAssetContainer::ingoreAssetConflicts()

Return Value:

true if asset conflicts in this container will be ignored, otherwise false.

Boolean : initChildren()

Initializes this containers child containers.

Return Value:

true if the containers were successfully initialized, otherwise false.

Boolean : insertAsset( DzAsset asset )

Attempts to insert the given asset into this container.

Parameter(s):

asset - The asset to add to this container.

Return Value:

true if the asset was successfully inserted, otherwise false.

Boolean : insertChildContainer( DzAbstractAssetContainer container )

Attempts to insert container as a child of this container.

Parameter(s):

container - The container to insert.

Return Value:

true if the container was successfully inserted, otherwise false.

Boolean : isFileSystemBased()

Return Value:

true if this container is based on a filesystem, otherwise false.

Boolean : moveFromParent( DzAbstractAssetContainer child )

Attempts to move the given container from its parent.

Parameter(s):

child - The container to move from its parent.

Return Value:

true if the container was successfully moved, otherwise false.

Boolean : removeAsset( DzAsset asset )

Attempts to remove the given asset from this container.

Parameter(s):

asset - The asset to remove.

Return Value:

true if the asset was successfully removed, otherwise false.

Boolean : removeAssetOnCut( DzAbstractAssetContainer toContainer )

Parameter(s):

toContainer - The container to check.

Return Value:

true if assets moved to toContainer should be removed from this container, otherwise false.

Boolean : removeChildContainer( DzAbstractAssetContainer container )

Attempts to remove the given container.

Parameter(s):

container - The container to remove.

Return Value:

true if the container was successfully removed, otherwise false.

Boolean : rename( String name )

Attempts to rename this container.

Parameter(s):

name - The new name for this container.

Return Value:

true if the rename was successful, otherwise false.

Boolean : renameAsset( DzAsset asset, String newAssetName )

Attempts to rename the given asset.

Parameter(s):

asset - The asset to rename.
newAssetName - The new name for the asset.

Return Value:

true if the asset was successfully renamed, otherwise false.

Boolean : renameChildContainer( DzAbstractAssetContainer container, String name )

Attempts to rename the given child container.

Parameter(s):

container - The container to rename.
name - The new name for the container.

Return Value:

true if the container was successfully renamed, otherwise false.

void : setContainerName( String name )

Sets the name for this container.

Parameter(s):

name - The new name for this container.

Boolean : update()

Attemps to update this container.

Return Value:

true if the update was successful, otherwise false.

Boolean : updateAssets()

Attempts to update the assets associated with this container.

Return Value:

true if the update was successful, otherwise false.

Signals

void : assetIconChanged( DzAsset asset )

Signature:“assetIconChanged(DzAsset*)”

Emitted the icon for an asset has changed.

Parameter(s):

asset - The asset that the icon changed for.

void : assetRenamed( DzAsset asset, Number index )

Signature:“assetRenamed(DzAsset*,int)”

Emitted when an asset has been renamed.

Parameter(s):

asset - The asset that was renamed.
index - The index of the asset that was renamed.

void : beginAssetAdd( Number start, Number end )

Signature:“beginAssetAdd(int,int)”

Emitted before assets are added.

Parameter(s):

start - …
end - …

void : beginAssetRemove( Number start, Number end )

Signature:“beginAssetRemove(int,int)”

Emitted before assets are removed.

Parameter(s):

start - …
end - …

void : beginChildContainerAdd( DzAbstractAssetContainer container, Number start, Number end )

Signature:“beginChildContainerAdd(DzAbstractAssetContainer*,int,int)”

Emitted before a child container is added.

Parameter(s):

container - The container being added.
start - …
end - …

void : beginChildContainerRemove( DzAbstractAssetContainer container, Number start, Number end )

Signature:“beginChildContainerRemove(DzAbstractAssetContainer*,int,int)”

Emitted before a child container is removed.

Parameter(s):

container - The container being removed.
start - …
end - …

void : childContainerAboutToBeRemoved( DzAbstractAssetContainer childContainer )

Signature:“childContainerAboutToBeRemoved(DzAbstractAssetContainerPtr)”

Emitted just before a child container is removed.

Parameter(s):

container - The child container that will be removed.

void : childContainerRemoved( DzAbstractAssetContainer childContainer )

Signature:“childContainerRemoved(DzAbstractAssetContainerPtr)”

Emitted after a child container has been removed.

Parameter(s):

childContainer - The child container that was removed.

void : endAssetAdd()

Signature:“endAssetAdd()”

Emitted after assets have been added.

void : endAssetRemove()

Signature:“endAssetRemove()”

Emitted after assets have been removed.

void : endChildContainerAdd()

Signature:“endChildContainerAdd()”

Emitted after a child container has been added.

void : endChildContainerRemove()

Signature:“endChildContainerRemove()”

Emitted after a child container has been removed.

void : iconChanged( DzAbstractAssetContainer container )

Signature:“iconChanged(DzAbstractAssetContainer*)”

Emitted after the icon for the container has changed.

Parameter(s):

container - The container with the icon that changed.

DzAbstractNodeEditorPane

2022-05-24T21:42:52+00:00

DzAbstractNodeEditorPane

An intermediate pane class to provide common functionality to several panes.

More...

Inherits :

QObject
- QWidget
  - DzPane

Inherited By : cameraspane_dz, lightspane_dz, posingpane_dz and shapingpane_dz

Methods

DAZ Script
Boolean	displaySeparate ()
contenttab_dz	getContentTab ()
DzGuidePage	getEditorGuidePage ()
DzInfoDivider	getInfoDivider ()
propertysidenavhierarchy_dz	getNodeEditor ()
DzGuidePage	getPresetGuidePage ()
void	setCurrentTab ( Number which )
void	showHidden ( Boolean onOff )
Boolean	showingHidden ()
void	toggleDisplaySeparate ()
void	toggleShowHidden ()

Signals

void	assetHoverChanged ( DzAsset asset )
void	currentTabChanged ( Number which )
void	showingHiddenChanged ( Boolean onOff )

Detailed Description

TODO: Add detailed description.

Methods

Boolean : displaySeparate()

Return Value:

true if each selected node is displayed separately in the navigation list, otherwise false.

contenttab_dz : getContentTab()

Return Value:

The Presets page widget for this pane.

DzGuidePage : getEditorGuidePage()

Return Value:

The guide page displayed for the editor page when no property group or property is selected.

DzInfoDivider : getInfoDivider()

Return Value:

The information divider for this pane.

propertysidenavhierarchy_dz : getNodeEditor()

Return Value:

The Editor page widget for this pane.

DzGuidePage : getPresetGuidePage()

Return Value:

The guide page displayed for the presets page when no category is selected.

void : setCurrentTab( Number which )

Sets the current page to the index specified by which; 0 based.

void : showHidden( Boolean onOff )

Sets whether or not hidden properties are displayed in the pane.

Parameter(s):

onOff - If true, hidden properties will be visible in the parameters list, otherwise hidden properties will not be displayed in the parameters list.

Boolean : showingHidden()

Return Value:

true if hidden properties are shown in the parameters list, false if hidden parameters are not being displayed in the parameters list.

void : toggleDisplaySeparate()

Toggle between whether each selected node is displayed separately in the navigation list or not.

void : toggleShowHidden()

Toggle between whether hidden properties are shown in the list or not.

Signals

void : assetHoverChanged( DzAsset asset )

Signature:“assetHoverChanged(const DzAssetPtr&)”

Emitted when the user hovers the cursor over an asset on the Presets page

Since:

4.6.4.112

void : currentTabChanged( Number which )

Signature:“currentTabChanged(int)”

Emitted when the current page changes

void : showingHiddenChanged( Boolean onOff )

Signature:“showingHiddenChanged(bool)”

Emitted when the option to show hidden properties changes

DzAction

2024-11-10T17:39:03+00:00

DzAction

Class that implements a user action.

More...

Inherits :

QObject

Inherited By : DzAssetIOFilterAction, DzCreateItemAction, DzEditAction, DzPaneAction, DzSaveAsSupportAction, savefilteraction_dz, DzScriptAction and DzViewToolAction

Properties

DAZ Script
String	actionGroup
Boolean	autoRepeat
Boolean	checkable
Boolean	checked
String	defaultMenu
Array	defaultMenus
Object	defaultSettings
String	defaultShortcut
String	defaultToolBar
Array	defaultToolBars
String	description
String	documentationUrl
Boolean	enabled
String	iconFile
Object	iconMap
String	iconText
Boolean	iconVisibleInMenu
String	shortcut
String	simpleText
String	statusTip
Number	styleIcon
String	text
String	toolTip
Object	triggerSettings
Boolean	visible
String	whatsThis

Methods

DAZ Script
Boolean	hasModifier ()
void	hover ()
String	modifierDescription ( Number modifiers )
void	setChecked ( Boolean onOff )
void	setDisabled ( Boolean onOff )
void	setEnabled ( Boolean onOff )
void	setOff ( Boolean onOff )
void	setVisible ( Boolean onOff )
void	toggle ()
void	trigger ()
void	triggerWithSettings ( Object settings )

Signals

void	changed ()
void	enabled ( Boolean onOff )
void	hovered ()
void	preExecute ()
void	toggled ( Boolean checked )
void	triggered ( Boolean checked )

Detailed Description

This class represents an action that the user can perform in the interface via pressing a hot key or clicking on a menu/toolbar item.

All action items are added to a list of interface actions which the user can customize. The user can specify their own keyboard shortcut or 'Hot Key' for the action, and any action item can be moved into a custom toolbar, as well as appear in the main menu.

See Also:

Properties

String : actionGroup

Holds the action group that this action belongs to (Read Only)

Boolean : autoRepeat

Holds whether this action will auto-repeat when the keyboard shortcut combination is held down.

Boolean : checkable

Holds whether this action is checkable (has an on/off state).

Boolean : checked

Holds whether this action is checked (on) - checkable must be true.

String : defaultMenu

Holds the primary menu that this action is added to by default, if the user has not chosen a custom location (Read Only)

Array : defaultMenus

Holds the menus that this action is added to by default, if the user has not chosen a custom location (Read Only).

Since:

4.6.2.62

Object : defaultSettings

Holds the settings revealed by a DzAction subclass author as being supported when triggerWithSettings() is called. (Read Only)

Since:

4.22.1.31

String : defaultShortcut

Holds the default keyboard shortcut (hotkey) that is associated with this action (Read Only before 4.6.4.48)

String : defaultToolBar

Holds the primary toolBar that this action is added to by default, if the user has not chosen a custom location (Read Only)

Array : defaultToolBars

Holds the toolBars that this action is added to by default, if the user has not chosen a custom location (Read Only).

Since:

4.6.2.62

String : description

Holds the user-readable description of the action.

String : documentationUrl

Holds the documentation URL for the action. (Read Only)

Since:

4.22.1.157

Boolean : enabled

Holds whether this action is enabled. Disabled actions cannot be triggered by the user via the UI.

Emitted when an action is enabled or disabled. onOff is true if the action was enabled, false if it was disabled.

String : iconFile

Holds the image file that is used as the icon for this action (if any).

Object : iconMap

Holds the map describing image files that are used in the icon for this action (if any).

Since:

4.22.1.169

String : iconText

Holds the descriptive icon text for this action.

Boolean : iconVisibleInMenu

Holds whether this action should show an icon in a menu.

String : shortcut

Holds the primary shortcut key sequence for this action.

String : simpleText

Holds the text of the action with any mnemonic (&) and/or trailing ellipsis (…) removed. (Read Only)

Since:

4.22.1.130

String : statusTip

Holds the status bar text for this action.

Number : styleIcon

Holds the standard pixmap that is used as the icon for this action (if any).

Since:

4.11.0.43

String : text

Holds the label for this action.

String : toolTip

Holds the popup tool tip text for this action.

Object : triggerSettings

Holds the settings used when triggerWithSettings() is called - will be empty if/when trigger() is called. (Read Only)

Since:

4.16.1.18

Boolean : visible

Holds whether this action can be seen in the UI (e.g., in menus and toolbars).

String : whatsThis

Holds the brief description text for this action.

Methods

Boolean : hasModifier()

Return Value:

true if this action offers a modified behavior when a keyboard modifier combination is pressed and the action is triggered, otherwise false.

See Also:

modifierDescription()

Since:

4.22.1.31

void : hover()

Activates the action in the 'Hover' state programatically.

See Also:

trigger()

String : modifierDescription( Number modifiers )

Parameter(s):

modifiers - A bitwise OR of the keyboard modifiers to retrieve a description for.

Return Value:

The description of the modified behavior for the specified keyboard modifier combination (if any), otherwise an empty string.

See Also:

hasModifier()
DzApp::modifierKeyState

Since:

4.22.1.31

void : setChecked( Boolean onOff )

Sets the action's toggle state.

Parameter(s):

onOff - If true, the action's toggle state is set on, otherwise, its toggle state is set off.

See Also:

setOff()

void : setDisabled( Boolean onOff )

Disables/Enables the action in the interface.

Parameter(s):

onOff - If true, the action will be 'grayed out' in menus, and the user will be unable to activate it. If false, the action will be enabled.

See Also:

setEnabled()

void : setEnabled( Boolean onOff )

Enables/Disables the action in the interface.

Parameter(s):

onOff - If true, the action will be displayed normally in menus, and the user will be able to activate it. If false, the action will be disabled.

See Also:

setDisabled()

void : setOff( Boolean onOff )

The same as calling setChecked( !onOff ). This method is provided for convenience when connecting this slot to a signal that emits a value that is the inverse of the desired onOff state.

Parameter(s):

onOff - If true, the action's toggle state is set off, otherwise, its toggle state is set on.

See Also:

setChecked()

void : setVisible( Boolean onOff )

Sets whether the action is visible in the interface.

Parameter(s):

onOff - If true, the action will be displayed in menus and toolbars that it has been added to. If false, the action will not be displayed in any menus or toolbars.

void : toggle()

Toggles the action programatically.

See Also:

trigger()

void : trigger()

Activates the action programatically.

See Also:

toggle()

void : triggerWithSettings( Object settings )

Triggers this action with the settings provided.

Parameter(s):

settings - The settings to use when the action is triggered.

Attention:

It is up to DzAction derived classes to determine if/how the settings are used.

See Also:

defaultSettings
triggerSettings

Since:

4.16.1.18

Signals

void : changed()

Signature:“changed()”

Emitted when an action has changed.

void : enabled( Boolean onOff )

TODO: Add description.

void : hovered()

Signature:“hovered()”

Emitted when an action is highlighted by the user; for example, when the user pauses with the cursor over a menu option, toolbar button, or presses an action's shortcut key combination.

void : preExecute()

Signature:“preExecute()”

Emitted immediately before executeAction() is called.

Since:

4.6.3.32

void : toggled( Boolean checked )

Signature:“toggled(bool)”

Emitted when a toggle action changes state. checked is the new action state, true for on, false for off.

void : triggered( Boolean checked )

Signature:“triggered(bool)”

Emitted when an action is activated by the user; for example, when the user clicks a menu option, toolbar button, or presses an action's shortcut key combination, or when trigger() was called. Notably, it is not emitted when setChecked() or toggle() is called. checked is true if the action is checked, or false if the action is unchecked.

DzActionMenu

2024-11-10T19:48:35+00:00

DzActionMenu

Class that encapsulates a popup menu that contains DzActionMenuItems.

More...

Inherits :

QObject

Enumerations

DAZ Script
MenuType	{ CustomMenu, PaneMenu, ViewToolMenu, SaveAsMenu, OpenRecentMenu }

Properties

DAZ Script
Boolean	isDefault
Number	menuType

Methods

DAZ Script
void	appendItemsFromMenu ( DzActionMenu menu )
void	clear ()
void	exec ()
void	exec ( Point pos )
DzActionMenu	findOrCreateSubMenu ( String path, Boolean asDefault=false )
DzActionMenu	findSubMenu ( String path )
DzActionMenuItem	getItem ( Number i )
Array	getItemList ()
Number	getNumItems ()
DzActionMenuItem	getParentItem ()
String	getPath ()
Boolean	hasItems ()
void	insertAction ( String identifier, Number i=-1 )
void	insertCustomAction ( String guid, Number i=-1 )
void	insertFileMergeAction ( String fileName, String label=“”, Number i=-1 )
void	insertFileOpenAction ( String fileName, String label=“”, Number i=-1 )
void	insertItem ( DzActionMenuItem item, Number i=-1 )
void	insertMenu ( String label, DzActionMenu menu, Number i=-1 )
void	insertSeparator ( Number i=-1 )
void	insertSubMenu ( String label, DzActionMenu menu, Boolean asDefault=false, Number i=-1 )
void	moveItem ( DzActionMenuItem item, Number i )
void	removeItem ( DzActionMenuItem item )
void	simplifySeparators ()

Signals

void	defaultChanged ( Boolean yesNo )
void	itemListChanged ()

Detailed Description

See Also:

Enumerations

: MenuType

TODO: Add description.

CustomMenu - A menu where each DzActionMenuItem is explicitly defined.
PaneMenu - A menu where each DzActionMenuItem is implicitly defined; built dynamically from DzPaneAction subclasses.
ViewToolMenu - A menu where each DzActionMenuItem is implicitly defined; built dynamically from DzViewToolAction subclasses.
SaveAsMenu - A menu where each DzActionMenuItem is implicitly defined; built dynamically from DzAssetIOFilterAction and savefilteraction_dz subclasses.
OpenRecentMenu - A menu where each DzActionMenuItem is implicitly defined; built dynamically from the return value of DzContentMgr::getRecentFileList(). Since: 4.6.0.44

Properties

Boolean : isDefault

Holds whether or not this menu is considered to be created by the application (true) or created by the user (false).

Since:

4.11.0.164

Number : menuType

Holds the type of this menu (Read Only until 4.6.0.74)

Methods

void : appendItemsFromMenu( DzActionMenu menu )

Appends menu items from the specified menu into this menu.

Parameter(s):

menu - The menu to copy items from.

Since:

4.22.1.205

void : clear()

Removes all items from this menu.

Attention:

This call has no effect unless the type of this menu is CustomMenu.

void : exec()

Displays this menu to the user.

void : exec( Point pos )

Displays this menu to the user at a specified position.

Parameter(s):

pos - The global window coordinates at which to display the popup menu.

DzActionMenu : findOrCreateSubMenu( String path, Boolean asDefault=false )

Parameter(s):

path - The slash ('/') delimited path of the submenu to find or create.
asDefault - If true, any menus that are created will be marked as a default menu; created/placed by the application. If false (default), any menus created will be marked as a custom menu; created/placed by the user.

Return Value:

The submenu at the given path; if a menu along the path does not already exist, it is created.

Since:

4.11.0.164

DzActionMenu : findSubMenu( String path )

Parameter(s):

path - The slash ('/') delimited path of the submenu to find.

Return Value:

The submenu with the given path (if any), otherwise null.

DzActionMenuItem : getItem( Number i )

Parameter(s):

i - The index of the item to return.

Return Value:

The menu item at the given index (if valid), otherwise null.

Array : getItemList()

Return Value:

A list of DzActionMenuItem in this menu.

Number : getNumItems()

Return Value:

The number of items in this menu.

DzActionMenuItem : getParentItem()

Return Value:

The item in a parent menu (if any) that causes this menu to be displayed, otherwise null.

Since:

4.11.0.164

String : getPath()

Return Value:

The slash ('/') delimited path of this action menu (if any), otherwise an empty string.

Since:

4.11.0.205

Boolean : hasItems()

Return Value:

true if there are items in this menu, otherwise false.

void : insertAction( String identifier, Number i=-1 )

Inserts an action into this menu at the specified position.

Parameter(s):

identifier - The name of the DzAction subclass to insert into this menu.
i - The index to insert the action at. If the index is invalid (default - i.e., i < 0, i > getNumItems()), the action is inserted at the last position in this menu.

void : insertCustomAction( String guid, Number i=-1 )

Inserts a custom action into this menu at the specified position.

Parameter(s):

guid - The globally unique identifier for the custom action to insert into this menu.
i - The index to insert the action at. If the index is invalid (default - i.e., i < 0, i > getNumItems()), the action is inserted at the last position in this menu.

Attention:

This call has no effect unless the type of this menu is CustomMenu.

void : insertFileMergeAction( String fileName, String label=“”, Number i=-1 )

Inserts a file merge action into this menu at the specified position.

Parameter(s):

fileName - The path of the file to insert into this menu.
label - The label to display within the interface; defaults to fileName if not specified.
i - The index to insert the action at. If the index is invalid (default - i.e., i < 0, i > getNumItems()), the action is inserted at the last position in this menu.

Attention:

This call has no effect unless the type of this menu is CustomMenu.

Since:

4.6.0.76

void : insertFileOpenAction( String fileName, String label=“”, Number i=-1 )

Inserts a file open action into this menu at the specified position.

Parameter(s):

fileName - The path of the file to insert into this menu.
label - The label to display within the interface; defaults to fileName if not specified.
i - The index to insert the action at. If the index is invalid (default - i.e., i < 0, i > getNumItems()), the action is inserted at the last position in this menu.

Attention:

This call has no effect unless the type of this menu is CustomMenu.

Since:

4.6.0.76

void : insertItem( DzActionMenuItem item, Number i=-1 )

Inserts a menu item into this menu at a specified position.

Parameter(s):

item - The item to insert into this menu.
i - The index to insert the menu item at. If the index is invalid (i.e., i < 0, i > getNumItems()), the item is inserted at the last position in this menu.

Attention:

This call has no effect unless the type of this menu is CustomMenu.

See Also:

moveItem()

void : insertMenu( String label, DzActionMenu menu, Number i=-1 )

Deprecated

Exists only to keep old code from crashing. Do not use in new code. Use insertSubMenu() instead.

void : insertSeparator( Number i=-1 )

Inserts a separator into this menu at the specified position.

Parameter(s):

i - The index to insert the separator at. If the index is invalid (default - i.e., i < 0, i > getNumItems()), the separator is inserted at the last position in this menu.

Attention:

This call has no effect unless the type of this menu is CustomMenu.

void : insertSubMenu( String label, DzActionMenu menu, Boolean asDefault=false, Number i=-1 )

Inserts a menu into this menu at the specified position as a submenu.

Parameter(s):

label - The label to display in this menu for the submenu item; the “/” character cannot be used.
menu - The submenu to insert into this menu; if null, a new menu is created at the given index.
asDefault - If true, this menu is inserted as a default menu. If false (default) this menu is inserted as a custom menu.
i - The index to insert the submenu at. If the index is invalid (default - i.e., i < 0, i > getNumItems()), the submenu is inserted at the last position in this menu.

Attention:

This call has no effect unless the type of this menu is CustomMenu.

See Also:

findOrCreateSubMenu()

Since:

4.11.0.164

void : moveItem( DzActionMenuItem item, Number i )

Moves a menu item in this menu to a specified position.

Parameter(s):

item - The menu item to move.
i - The index to move the menu item to. If the index is invalid (i.e., i < 0, i > getNumItems()), the item is moved to the last position in this menu.

Attention:

This call has no effect unless the type of this menu is CustomMenu. This call has no effect if item is not in this menu.

See Also:

insertItem()

Since:

4.22.0.2

void : removeItem( DzActionMenuItem item )

Removes a menu item from this menu.

Parameter(s):

item - The menu item to remove.

Attention:

This call has no effect unless the type of this menu is CustomMenu.

void : simplifySeparators()

Removes any duplicate separators from this menu by replacing two or more adjacent separators with a single separator.

Signals

void : defaultChanged( Boolean yesNo )

Signature:“defaultChanged(bool)”

Emitted when the default state of this menu has been changed.

Parameter(s):

yesNo - The new default state for this menu.

Since:

4.11.0.164

void : itemListChanged()

Signature:“itemListChanged()”

Emitted when items are added to or removed from this menu.

DzActionMenuItem

2024-11-10T17:39:03+00:00

DzActionMenuItem

Class that encapsulates an 'Action Menu Item'.

More...

Inherits :

QObject

Enumerations

DAZ Script
Type	{ Separator, Action, CustomAction, SubMenu, FileOpenAction, FileMergeAction }

Properties

DAZ Script
String	action
Boolean	isDefault
String	label
Type	type

Methods

DAZ Script
DzActionMenu	getParentMenu ()
DzActionMenu	getSubMenu ()
void	loadFile ()
void	setSubMenu ( DzActionMenu menu )

Detailed Description

Action Menu Items are registered with a DzActionMenu and are available to access via methods on that class.

Enumerations

: Type

The types of action menu items.

Separator - A menu separator (i.e., horizontal divider).
Action - A menu item that activates a DzAction object.
CustomAction - A menu item that activates a custom action. See Also: DzActionMgr - for more about custom actions.
SubMenu - A menu item that opens a submenu.
FileOpenAction - A menu item that opens a file, replacing the contents of the current scene. See Also: DzContentMgr::openFile() - for more about opening a file.
FileMergeAction - A menu item that merges a file with the current scene. See Also: DzContentMgr::openFile() - for more about merging a file.

Properties

String : action

Holds the identifier for the Action (classname), CustomAction (GUID), FileOpenAction or FileMergeAction (file path) to perform.

Boolean : isDefault

Holds whether or not this menu item is considered to be placed by the application (true) or placed by the user (false).

Since:

4.6.0.83

String : label

Holds the label displayed for the item.

Since:

4.6.0.76 - Note: Prior to 4.12.1.68, items of the Action and CustomAction type would yeild an empty string.

Type : type

Holds the type of this menu item. (Read Only)

Methods

DzActionMenu : getParentMenu()

Return Value:

The menu that this item is in.

Since:

4.11.0.164

DzActionMenu : getSubMenu()

Return Value:

The submenu that is displayed by this menu item (if any), otherwise null.

void : loadFile()

Causes the file for a FileOpenAction or FileMergeAction item to load.

Attention:

If the [Ctrl/Cmd] key is pressed when this method is called, the path of the file will be opened in the OS native file browser instead of being opened/merged (since 4.7.1.107). If the type of this item is FileOpenAction and the [Shift] key is pressed when this method is called, the file will be treated as though the type of this item is FileMergeAction (since 4.22.0.3).

Since:

4.6.0.44

void : setSubMenu( DzActionMenu menu )

Sets the menu that is displayed as a submenu when this menu item is activated.

Parameter(s):

menu - The menu that is displayed as a submenu when this menu item is activated. The menu item takes ownership of this menu - this menu will be deleted when this item is destroyed.

Attention:

This call has no effect unless the type of this item is SubMenu.

DzActionMgr

2024-11-10T20:32:50+00:00

DzActionMgr

Manager responsible for actions.

More...

Inherits :

QObject
- QWidget

Constructors

DAZ Script
startic	legalizeName ( String name )

Methods

DAZ Script
String	addCustomAction ( String text, String desc, String script, Boolean isFile=true, String shortcut=“”, String iconFile=“” )
void	clearActiveMenu ()
DzAction	findAction ( String identifier )
Array	findActionsForShortcut ( String shortcut )
Number	findCustomAction ( String guid )
DzAction	findPaneAction ( String identifier )
DzPersistentMenu	findPersistentMenu ( String className )
DzAction	findViewToolAction ( String className )
DzAction	getAction ( Number index )
DzActionMenu	getActiveMenu ()
Number	getCustomAction ( String guid )
DzAction	getCustomActionByIndex ( Number index )
String	getCustomActionDescription ( Number index )
String	getCustomActionFile ( Number index )
String	getCustomActionIcon ( Number index )
String	getCustomActionName ( Number index )
String	getCustomActionScript ( Number index )
String	getCustomActionShortcut ( Number index )
Number	getCustomActionShowTextWithIcon ( Number index )
String	getCustomActionText ( Number index )
String	getDocumentationUrl ()
DzActionMenu	getMenu ()
Number	getNumActions ()
Number	getNumCustomActions ()
Number	getNumPersistentMenus ()
DzPersistentMenu	getPersistentMenu ( Number index )
Boolean	loadInterfaceFile ( String filename, Boolean overrideDefaults )
void	removeAllCustomActions ()
void	removeCustomAction ( Number index )
Boolean	saveActionsFile ( String filename )
Boolean	saveCustomActionsFile ( String filename )
Boolean	saveInterfaceFiles ()
Boolean	saveMenusFile ( String filename )
Boolean	saveToolBarsFile ( String filename )
void	setAccel ( String className, String key )
void	setActiveMenu ( DzActionMenu menu )
void	setCustomActionDescription ( Number index, String desc )
void	setCustomActionIcon ( Number index, String iconFile )
void	setCustomActionScript ( Number index, String script, Boolean isFile=true )
void	setCustomActionShortcut ( Number index, String shortcut )
void	setCustomActionShowTextWithIcon ( Number index, Boolean onOff )
void	setCustomActionText ( Number index, String text )
void	unsetAccel ( String key )

Signals

void	customActionAdded ( String name )
void	customActionListChanged ()
void	customActionRemoved ( String name )

Detailed Description

Responsible for the management of actions that the user can perform in the interface by pressing the key combination specified by its shortcut or by clicking on a menu/toolbar item.

There is only one instance of this manager in an application. This instance is created and owned by DzMainWindow. Request the instance via DzMainWindow::getActionMgr().

See Also:

Constructors

startic : legalizeName( String name )

Uses the regular expression “([A-z]+[A-z0-9]*)” to strip characters/symbols/etc from a string in order to 'legalize' it.

Parameter(s):

name - The name to 'legalize.'

Return Value:

A 'legalized' version of name.

Since:

4.6.2.102

Methods

String : addCustomAction( String text, String desc, String script, Boolean isFile=true, String shortcut=“”, String iconFile=“” )

Adds a custom action to the action manager.

Parameter(s):

text - The text of the action. This is displayed in menus the action added to unless a different menu text is specified.
desc - The description of the action.
script - The filename of the script to execute, or the actual text of the script to execute.
isFile - If true, then script is assumed to contain a filename, otherwise script is assumed to be the actual script.
shortcut - The default keyboard shortcut for the action.
iconFile - The path of an image file that will be the icon for the action.

Return Value:

The globally unique identifier for the newly created custom action.

void : clearActiveMenu()

Clears the active menu.

DzAction : findAction( String identifier )

Parameter(s):

identifier - The classname of the DzAction subclass to find the action for.

Return Value:

The DzAction subclass with the specified classname (if any), otherwise null.

Example:

var oMgr = MainWindow.getActionMgr();
 
// Find the 'New File' action and print its accelerator to the log file
var oAction = oMgr.findAction( "DzNewAction" );
if( oAction ){
	print( oAction.text, ": ", oAction.shortcut );
}

Array : findActionsForShortcut( String shortcut )

Parameter(s):

shortcut - The shortcut to find actions for.

Return Value:

The list of actions whose shortcuts start with the specified sequence (if any), otherwise an empty list.

Example:

(function(){
 
	var oActionMgr = MainWindow.getActionMgr();
 
	var oAction;
 
	var aActions = oActionMgr.findActionsForShortcut( "Ctrl+N" );
	for( var i = 0, n = aActions.length; i < n; i += 1 ){
		oAction = aActions[ i ];
		if( oAction.inherits( "DzCustomAction" ) ){
			print( i, "Custom:", oAction.name, ":", oAction.shortcut );
		} else {
			print( i, oAction.className(), ":", oAction.shortcut );
		}
	}
 
})();

Since:

4.12.1.63

Number : findCustomAction( String guid )

Parameter(s):

guid - The globally unique identifier (name) of the custom action to find.

Return Value:

The index of the custom action with the specified identifier (if any), otherwise -1.

DzAction : findPaneAction( String identifier )

Parameter(s):

identifier - The classname of the DzPane to find the action for.

Return Value:

The action that toggles visibility of the specified DzPane (if any), otherwise null.

Example:

var oMgr = MainWindow.getActionMgr();
 
// Find the action for the 'Smart Content' pane and print its accelerator to the log file
var oAction = oMgr.findPaneAction( "DzSmartContentPane" );
if( oAction ){
	print( oAction.text, ": ", oAction.shortcut );
}

Since:

4.8.1.18

DzPersistentMenu : findPersistentMenu( String className )

Parameter(s):

className - The class name of the persistent menu to find.

Return Value:

The persistent menu of the specified class type (if any), otherwise null.

DzAction : findViewToolAction( String className )

Parameter(s):

className - The class name of the DzViewTool to find the action for.

Return Value:

The action that activates the specified DzViewTool subclass (if any), otherwise null.

Example:

var oMgr = MainWindow.getActionMgr();
 
// Find the action for the 'Universal' tool and print its accelerator to the log file
var oAction = oMgr.findViewToolAction( "DzUniversalTool" );
if( oAction ){
	print( oAction.text, ": ", oAction.shortcut );
}

Since:

4.8.1.18

DzAction : getAction( Number index )

Parameter(s):

index - The index of the action to return.

Return Value:

The DzAction subclass at the specified index (if any), otherwise null.

Example:

var oAction;
var oMgr = MainWindow.getActionMgr();
 
// Go through the list of actions and print their accelerators to the log file
var nActions = oMgr.getNumActions();
for( var i = 0; i < nActions; i++ ){
	oAction = oMgr.getAction( i );
	print( oAction.text, ": ", oAction.shortcut );
}

DzActionMenu : getActiveMenu()

Return Value:

The currently set active menu (if any), otherwise null.

Number : getCustomAction( String guid )

Parameter(s):

guid - The globally unique identifier (name) of the custom action to get.

Return Value:

The index of the custom action with the specified GUID; creates a custom action if one does not already exist.

See Also:

findCustomAction()

DzAction : getCustomActionByIndex( Number index )

Parameter(s):

index - The index of the custom action to return.

Return Value:

The custom action at the specified index (if any), otherwise null.

Attention:

The return object (if any) will inherit DzCustomAction.

See Also:

findCustomAction()
getNumCustomActions()

Since:

4.12.1.63

String : getCustomActionDescription( Number index )

Parameter(s):

index - The index of the custom action to get the description of.

Return Value:

The description for the custom action at the specified index (if any), otherwise an empty string.

Since:

4.11.0.164

String : getCustomActionFile( Number index )

Parameter(s):

index - The index of the custom action to get the filename for.

Return Value:

If the custom action refers a file, the path to the file for the custom action at the specified index (if any), otherwise an empty string.

String : getCustomActionIcon( Number index )

Parameter(s):

index - The index of the custom action to get the icon file for.

Return Value:

The icon file for the custom action at the specified index (if any), otherwise an empty string.

String : getCustomActionName( Number index )

Parameter(s):

index - The index of the custom action to get the name of.

Return Value:

The globally unique identifier for the custom action at the specified index (if any), otherwise an empty string.

String : getCustomActionScript( Number index )

Parameter(s):

index - The index of the custom action to get information for.

Return Value:

The script code executed by the custom action or an empty string if the custom action refers to a file (if any), otherwise an empty string.

String : getCustomActionShortcut( Number index )

Parameter(s):

index - The index of the custom action to return the shortcut for.

Return Value:

The keyboard shortcut for the custom action at the specified index (if any), otherwise an empty string.

Number : getCustomActionShowTextWithIcon( Number index )

Parameter(s):

index - The index of the custom action to check.

Return Value:

1 if action text is displayed with the icon for the custom action at index, 0 if action text is not displayed with the icon, -1 if index is out of range.

Since:

4.22.1.182

String : getCustomActionText( Number index )

Parameter(s):

index - The index of the custom action to get the text for.

Return Value:

The text for the custom action at the specified index (if any), otherwise an empty string.

String : getDocumentationUrl()

Return Value:

The online URL for action documentation.

Since:

4.22.1.208

DzActionMenu : getMenu()

Return Value:

The Main Menu for the application.

Number : getNumActions()

Return Value:

The number of action items in the application.

Number : getNumCustomActions()

Return Value:

The number of custom actions in the action manager.

Number : getNumPersistentMenus()

Return Value:

The number of persistent menus in the application.

DzPersistentMenu : getPersistentMenu( Number index )

Parameter(s):

index - The index of the persistent menu to return.

Return Value:

The persistent menu at the specified index (if any), otherwise null.

Boolean : loadInterfaceFile( String filename, Boolean overrideDefaults )

Builds the main menu, pane menus and tool bars from the specified file.

Parameter(s):

filename - The absolute path of the interface file to load.
overrideDefaults - Whether default triggers (i.e. version numbers on menus) cause certain items to be rebuilt using their defaults.

Return Value:

true if the file was successfully loaded, otherwise false.

Since:

4.6.0.78

void : removeAllCustomActions()

Removes all custom actions from the application.

void : removeCustomAction( Number index )

Removes the custom action at the specified index.

Parameter(s):

index - The index of the custom action to remove.

Boolean : saveActionsFile( String filename )

Saves the actions to the specified file.

Parameter(s):

filename - The absolute path of the file to save the interface settings to.

Return Value:

true if the file was saved successfully, otherwise false.

Boolean : saveCustomActionsFile( String filename )

Saves custom actions to the specified file.

Parameter(s):

filename - The absolute path of the file to save the interface settings to.

Return Value:

true if the file was saved successfully, otherwise false.

Boolean : saveInterfaceFiles()

Saves the actions, menus and toolbars to their respective files in the default location.

Return Value:

true if the files were saved successfully, otherwise false.

See Also:

saveActionsFile()
saveMenusFile()
saveToolBarsFile()
saveInterfaceFiles()

Boolean : saveMenusFile( String filename )

Saves the main menu, pane menus, persistent menus, and view tool menus to the specified file.

Parameter(s):

filename - The absolute path of the file to save the interface settings to.

Return Value:

true if the file was saved successfully, otherwise false.

Boolean : saveToolBarsFile( String filename )

Saves the tool bars to the specified file.

Parameter(s):

filename - The absolute path of the file to save the interface settings to.

Return Value:

true if the file was saved successfully, otherwise false.

void : setAccel( String className, String key )

Parameter(s):

className - The name of the action class to set the accelerator for.
key - The string representation of the accelerator.

Example:

var oMgr = MainWindow.getActionMgr();
 
// Set the accelerator for the 'New File' action to be the 'Ctrl' key and the 'N' key
oMgr.setAccel( "DzNewAction", "Ctrl+N" );

void : setActiveMenu( DzActionMenu menu )

Sets the active menu, so that actions relying on the active menu can get it. This may be called before the menu exec() call to allow context for script actions.

Parameter(s):

menu - The menu to set as the active menu.

void : setCustomActionDescription( Number index, String desc )

Sets the description for the custom action at the specified index.

Parameter(s):

index - The index of the custom action to set the description for.
desc - The description of the custom action.

Since:

4.11.0.164

void : setCustomActionIcon( Number index, String iconFile )

Sets the icon for the custom action at the specified index.

Parameter(s):

index - The index of the custom action to set the icon file for.
iconFile - The path of the image file that will be loaded for the action's icon. The path can be absolute, or relative to DzApp::getResourcesPath().

void : setCustomActionScript( Number index, String script, Boolean isFile=true )

Sets the script for the custom action at the specified index.

Parameter(s):

index - The index of the custom action to set the script for.
script - The script to set as the Custom action's script.
isFile - If true, script contains the name of a script file that should be loaded. If false, script contains the code for the action's script.

void : setCustomActionShortcut( Number index, String shortcut )

Sets the keyboard shortcut for the custom action at the specified index.

Parameter(s):

index - The index of the custom action to set the shortcut for.
shortcut - The string representation of the shortcut.

Since:

4.9.4.102

void : setCustomActionShowTextWithIcon( Number index, Boolean onOff )

Sets whether the text of the action is displayed with the icon for the custom action at the specified index.

Parameter(s):

index - The index of the custom action to set.
onOff - If true, the text of the action is always displayed with the icon (e.g., in toolbars).

void : setCustomActionText( Number index, String text )

Sets the text for the custom action at the specified index.

Parameter(s):

index - The index of the custom action to set the text for.
text - The new text for the action.

void : unsetAccel( String key )

Parameter(s):

key - The accelerator to remove from actions in the app.

Example:

var oMgr = MainWindow.getActionMgr();
 
// Unset the accelerator for the action using 'Control + N'
oMgr.unsetAccel( "Ctrl+N" );

Signals

void : customActionAdded( String name )

Signature:“customActionAdded(const QString&)”

Emitted when a custom action is added to the action manager.

void : customActionListChanged()

Signature:“customActionListChanged()”

Emitted when custom actions are added to or removed from the action manager.

void : customActionRemoved( String name )

Signature:“customActionRemoved(const QString&)”

Emitted when a custom action is removed from the action manager.

DzActivityLayout

2022-05-24T21:42:51+00:00

DzActivityLayout

Defines the layout of an Activity of the interface.

More...

Inherits :

Properties

DAZ Script
String	description
String	label

Constructors

DAZ Script
DzActivityLayout ( String label, String desc )

Methods

DAZ Script
void	clearMemorizedState ()
Boolean	isToolBarEnabled ( String toolbar )
void	setToolbarEnabled ( String toolbar, Boolean onOff )

Signals

void	labelChanged ( String label )

Detailed Description

Defines the layout of Toolbars, Pane Groups, Panes, Viewports and the active View Tool within an Activity of the interface.

See Also:

Properties

String : description

The description of this activity

String : label

The label of this activity

Constructors

DzActivityLayout( String label, String desc )

Default Constructor. Creates a new activity layout with the given name and description.

Parameter(s):

label - The label that the user will see for this layout in this activity tabs
description - The description of the layout.

Methods

void : clearMemorizedState()

Clears the memorized state of this activity.

Boolean : isToolBarEnabled( String toolbar )

Parameter(s):

toolbar - The name of the toolbar.

Return Value:

Whether or not the toolbar is enabled for this activity layout.

void : setToolbarEnabled( String toolbar, Boolean onOff )

Sets whether or not a toolbar is enabled in this activity.

Parameter(s):

toolbar - The name of the toolbar.
onOff - The enabled state to set.

Signals

void : labelChanged( String label )

Signature:“labelChanged(const QString&)”

Emitted when the layout's label has changed.

Parameter(s):

label - The new label for the layout.

DzAddBlend (deprecated)

2021-07-12T16:33:52+00:00

DzAddBlend (deprecated)

An additive image blending operation. (deprecated).

More...

Inherits :

QObject
- DzImageBlend (deprecated)

Constructors

DAZ Script
DzAddBlend ()

Detailed Description

Deprecated

Exists only to keep code written prior to 4.6.2.23 working. Do not use in new code. Use DzTextureLayer::BlendAdd instead.

Constructors

DzAddBlend()

Default Constructor.

DzAlembicExporter

2017-09-11T05:02:20+00:00

DzAlembicExporter

Class for exporting to the Alembic (*.abc) format.

More...

Inherits :

QObject
- DzBase
  - DzFileIO
    - DzExporter

Constructors

DAZ Script
DzAlembicExporter ()

Detailed Description

See Also:

Attention:

This class is provided by the Alembic Exporter for DAZ Studio plugin.

Constructors

DzAlembicExporter()

Default Constructor.

DzAlphaBlend (deprecated)

2021-07-12T16:34:02+00:00

DzAlphaBlend (deprecated)

A blending operation that uses the alpha channel of the source image to blend it into the destination. (deprecated).

More...

Inherits :

QObject
- DzImageBlend (deprecated)

Constructors

DAZ Script
DzAlphaBlend ()

Detailed Description

Deprecated

Exists only to keep code written prior to 4.6.2.23 working. Do not use in new code. Use DzTextureLayer::BlendAlpha instead.

Constructors

DzAlphaBlend()

Default Constructor

DzApp

2024-11-10T21:27:16+00:00

DzApp

The main application object.

More...

Inherits :

QObject

Enumerations

DAZ Script
GraphicsMode	{ NoInterface, NoInterfaceWithOpenGL, FullInterface }
MessageSeverity	{ MessageFatal, MessageError, MessageWarning, MessageNormal, MessageVerbose, MessageDebug, MessageRaw }
OperatingSystem	{ OS_Unknown, Windows_Unknown, Windows_95, Windows_98, Windows_Me, Windows_2000, Windows_XP, Windows_2003, Windows_Vista, Windows_7, Windows_8, Windows_8_1, Windows_10, Windows_11, Mac_Unknown, Mac_10_0, Mac_10_1, Mac_10_2, Mac_10_3, Mac_10_4, Mac_10_5, Mac_10_6, Mac_10_7, Mac_10_8, Mac_10_9, Mac_10_10, Mac_10_11, Mac_10_12, Mac_10_13, Mac_10_14, Mac_10_15, Mac_11_0, Mac_12_0, Mac_13_0, Mac_14_0, Mac_15_0 }
Platform	{ Windows, MacOSX }
ReleaseCycle	{ GeneralRelease, PublicBuild, PublishingBuild, PrivateBuild, DevBuild }
ReleaseEdition	{ Free, Standard, Advanced, Pro, Alpha, Beta }

Properties

DAZ Script
String	appName
String	cloudName
Number	exitCode
Number	logSize
String	longVersionString
String	orgName
Array	scriptArgs
String	systemLocaleName
Number	version
Number	version64
String	versionString

Static Methods

DAZ Script
String	durationToString ( Number mSecs, Boolean simplified=false, Boolean useLocale=true )
DzVersion	getPlatformVersion ()
DzVersion	getVersion ()
Boolean	hasActiveModalWidget ()

Methods

DAZ Script
Number	bitArchitecture ()
String	bitArchitectureString ()
String	byteSizeToString ( Number bytes )
Boolean	canShowSceneBuilder ( Object definition=undefined )
void	clearDelayedDeleteStack ( Boolean doProgress )
void	clearPixmapCache ()
Object	cpuInfo ()
String	createDigest ( Array tokens )
String	createDigest ( ByteArray data )
String	createUuid ()
void	debug ( String message )
void	delayedExit ( Number exitCode=0 )
void	enableMultiThreading ( Boolean onOff )
void	error ( String message )
void	fatal ( String message )
Boolean	flushLogBuffer ()
String	getAbsoluteScriptPath ( String scriptName )
String	getAppDataInstancePath ()
String	getAppDataPath ()
String	getApplicationBaseName ()
String	getApplicationDataName ()
DzAssetIOMgr	getAssetIOMgr ()
DzAssetMgr	getAssetMgr ()
DzAuthenticationMgr	getAuthenticationMgr ()
DzCallBackMgr	getCallBackMgr ()
String	getCloudLogFilename ()
String	getCommonUserDocumentPath ()
DzContentMgr	getContentMgr ()
DzAuthor	getCurrentAuthor ()
String	getDataFolderName ()
String	getDataFolderPath ()
String	getDataFolderPathBase ()
String	getDAZDataPath ()
String	getDefaultTempPath ()
DzDeviceMgr	getDeviceMgr ()
QWidget	getDialogParent ()
String	getDocumentationPath ()
String	getDocumentationUrl ()
String	getDocumentsPath ()
DzExportMgr	getExportMgr ()
DzFileIOPresetMgr	getFileIOPresetMgr ()
String	getGeneratedScriptsPath ()
String	getGeneratedShadersPath ()
GraphicsMode	getGraphicsMode ()
DzHelpMgr	getHelpMgr ()
String	getHomePath ()
DzImageMgr	getImageMgr ()
DzImportMgr	getImportMgr ()
DzMainWindow	getInterface ()
String	getLoadSavePath ()
String	getLogFilename ()
DzMultiMediaMgr	getMultiMediaMgr ()
DzPluginMgr	getPluginMgr ()
String	getPluginsPath ()
String	getProgramDataAppInstancePath ()
String	getProgramDataAppPath ()
String	getProgramDataPath ()
DzRenderMgr	getRenderMgr ()
String	getResourcesPath ()
String	getScriptsPath ()
String	getShadersPath ()
DzSimulationMgr	getSimulationMgr ()
DzStyle	getStyle ()
String	getStyleDefinition ()
Array	getStyleDefinitionList ()
String	getTempFilename ()
String	getTempPath ()
String	getTempRenderFilename ()
String	getTempShadersPath ()
String	getUtilitiesPath ()
String	instanceName ()
String	instanceNameSuffix ()
Boolean	isClosing ()
Boolean	isEmittingLogMessages ()
Boolean	isKeyDown ( Number key=-1 )
Boolean	isKeySequenceDown ( String sequence=“Any” )
Boolean	isMultiThreadingEnabled ()
Boolean	isRegistered ()
Boolean	isRunning ()
Boolean	isSlave ()
Boolean	isStarting ()
Boolean	isValidGuid ( String data )
void	log ( String message )
void	logMessageBox ( String category, String title, String text, Array buttonTexts, Boolean immediate )
void	logPathInfo ( String label, String path )
Number	modifierKeyState ()
OperatingSystem	operatingSystem ()
String	operatingSystemString ()
Platform	platform ()
void	postScriptEvent ( Boolean evaluate, String script, Array args=[] )
ReleaseCycle	releaseCycle ()
String	releaseCycleInstanceString ()
String	releaseCycleInstanceSuffix ()
String	releaseCycleInstanceSuffixStripped ()
String	releaseCycleLocaleString ()
String	releaseCycleString ()
String	releaseCycleSuffix ()
String	releaseCycleSuffixStripped ()
ReleaseEdition	releaseEdition ()
String	releaseEditionLocaleString ()
String	releaseEditionString ()
void	restoreDefaultTempPath ()
void	setLoadSavePath ( String path )
Boolean	setStyleDefinition ( String name )
Boolean	setTempPath ( String tempPath )
Boolean	showInNativeBrowser ( String absFilePath )
Boolean	showPrompts ()
Array	showSceneBuilder ( Object definition=undefined, Boolean asEvent=false )
void	showURL ( String url )
void	statusLine ( String message, Boolean addToLog=true )
Boolean	usingInterface ()
void	verbose ( String message )
void	warning ( String message )
Boolean	writeConfigScript ( String configScriptFilename=“” )
void	writeToLog ( String message )
void	writeToLog ( MessageSeverity severity, String category, String message, Boolean immediate )
void	writeToLog ( String message, Boolean immediate )
void	writeToLog ( MessageSeverity severity, String message, Boolean immediate )
Deprecated
DzSaveFilterMgr (deprecated)	getSaveFilterMgr ()
DzAppSettingsMgr	getAppSettingsMgr ()

Signals

Deprecated
void	closing ()
void	debugMessage ( String message, String category )
void	errorMessage ( String message, String category )
void	eventLoopStarted ()
void	fatalMessage ( String message, String category )
void	infoMessage ( String message, String category )
void	mouseEvent ()
void	multiThreadingChanged ( Boolean onOff )
void	sceneBuilderAccepted ( Array selections )
void	sceneBuilderRejected ()
void	starting ()
void	styleAboutToChange ()
void	styleChanged ( DzStyle newStyle )
void	verboseMessage ( String message, String category )
void	warningMessage ( String message, String category )
void	debugMsg ( String message )
void	warningMsg ( String message )

Detailed Description

Derived from QApplication, this class embodies the main event loop, and owns application-wide settings and objects not directly related to the user interface.

Can be directly accessed using the Global::App variable.

Enumerations

: GraphicsMode

The current graphical systems available in the application.

NoInterface - No interface or graphical subsystem is initialized.
NoInterfaceWithOpenGL - The OpenGL subsystem is initialized without a user interface.
FullInterface - The user interface and all graphical subsystems are initialized.

—–

: MessageSeverity

The severity of a message sent to the application log.

Since:

4.16.1.26

MessageFatal - A fatal error message.
MessageError - An error message.
MessageWarning - A warning message.
MessageNormal - A normal operation message.
MessageVerbose - A more verbose message.
MessageDebug - A debugging message.
MessageRaw - A message with no leading qualifier.

—–

: OperatingSystem

Enumerated values representing the Operating System under which the application is currently running.

OS_Unknown - An unknown operating system. Since: 4.11.0.235
Windows_Unknown - An unknown version of the Windows operating system. Since: 4.11.0.235
Windows_95 - The “Windows 95” (Windows 4.0) operating system. Since: 4.11.0.235
Windows_98 - The “Windows 98” (Windows 4.1) operating system. Since: 4.11.0.235
Windows_Me - The “Windows Millennium Edition” aka “ME” (Windows 4.9) operating system. Since: 4.11.0.235
Windows_2000 - The “Windows 2000” (Windows NT 5.0) operating system. Since: 4.11.0.235
Windows_XP - The “Windows XP” (Windows NT 5.1) operating system. Since: 4.11.0.235
Windows_2003 - The “Windows 2003” (Windows NT 5.2) operating system. Since: 4.11.0.235
Windows_Vista - The “Windows Vista” (Windows NT 6.0) operating system. Since: 4.11.0.235
Windows_7 - The “Windows 7” (Windows NT 6.1) operating system. Since: 4.11.0.235
Windows_8 - The “Windows 8” (Windows NT 6.2) operating system. Since: 4.11.0.235
Windows_8_1 - The “Windows 8.1” (Windows NT 6.3) operating system. Since: 4.11.0.235
Windows_10 - The “Windows 10” (Windows NT 10) operating system. Since: 4.11.0.235
Windows_11 - The “Windows 11” (Windows NT 11) operating system. Since: 4.15.0.22
Mac_Unknown - An unknown version of the Mac OS X/OS X/macOS operating system. Since: 4.11.0.235
Mac_10_0 - The “Mac OS X 10.0” (aka “Cheetah”) operating system. Since: 4.11.0.235
Mac_10_1 - The “Mac OS X 10.1” (aka “Puma”) operating system. Since: 4.11.0.235
Mac_10_2 - The “Mac OS X 10.2” (aka “Jaguar”) operating system. Since: 4.11.0.235
Mac_10_3 - The “Mac OS X Panther” (version 10.3) operating system. Since: 4.11.0.235
Mac_10_4 - The “Mac OS X Tiger” (version 10.4) operating system. Since: 4.11.0.235
Mac_10_5 - The “Mac OS X Leopard” (version 10.5) operating system. Since: 4.11.0.235
Mac_10_6 - The “Mac OS X Snow Leopard” (version 10.6) operating system. Since: 4.11.0.235
Mac_10_7 - The “Mac OS X Lion” (version 10.7) operating system. Since: 4.11.0.235
Mac_10_8 - The “OS X Mountain Lion” (version 10.8) operating system. Since: 4.11.0.235
Mac_10_9 - The “OS X Mavericks” (version 10.9) operating system. Since: 4.11.0.235
Mac_10_10 - The “OS X Yosemite” (version 10.10) operating system. Since: 4.11.0.235
Mac_10_11 - The “OS X El Capitan” (version 10.11) operating system. Since: 4.11.0.235
Mac_10_12 - The “macOS Sierra” (version 10.12) operating system. Since: 4.11.0.235
Mac_10_13 - The “macOS High Sierra” (version 10.13) operating system. Since: 4.11.0.235
Mac_10_14 - The “macOS Mojave” (version 10.14) operating system. Since: 4.11.0.235
Mac_10_15 - The “macOS Catalina” (version 10.15) operating system. Since: 4.12.1.16
Mac_11_0 - The “macOS Big Sur” (version 11.0) operating system. Since: 4.15.0.22
Mac_12_0 - The “macOS Monterey” (version 12.0) operating system. Since: 4.15.0.22
Mac_13_0 - The “macOS Ventura” (version 13.0) operating system. Since: 4.21.1.11
Mac_14_0 - The “macOS Sonoma” (version 14.0) operating system. Since: 4.22.0.16
Mac_15_0 - The “macOS Sequoia” (version 15.0) operating system. Since: 4.22.1.171

—–

: Platform

Enumerated values representing the hardware/software environment on which the application is currently running.

Windows - The Windows hardware/software environment.
MacOSX - The Mac OS X|OS X|macOS hardware/software environment.

—–

: ReleaseCycle

Enumerated values representing the release cycles (channels) for the application.

GeneralRelease - A build of the application that is considered stable, and has been made available to the general public.
PublicBuild - A build of the application that is not considered stable yet, but has been made available to the general public for testing.
PublishingBuild - A build of the application that is not considered ready for the general public, but is considered stable enough to introduce into a production environment by early adopters; typically only made available to our Published Artists.
PrivateBuild - A build of the application that is not considered stable yet, but has been made available to a select group of individuals that serve as the “front line” or the “canary in a coal mine” for a time before the build is promoted to a channel that is less restricted.
DevBuild - A build that is used by developers of the application during the development process.

—–

: ReleaseEdition

Enumerated values representing a set of features in the application.

Free - An edition of the application that provides the “Free” set of features.
Standard - An edition of the application that provides the “Standard” set of features.
Advanced - An edition of the application that provides the “Advanced” set of features.
Pro - An edition of the application that provides the “Professional” set of features.
Alpha - An edition of the application that provides the “Alpha” set of features.
Beta - An edition of the application that provides the “Beta” set of features.

Properties

String : appName

Holds the name of the application; i.e., “DAZ Studio”. (Read Only)

String : cloudName

Holds the name of the cloud service; i.e., “Daz Connect”. (Read Only)

Since:

4.9.0.26

Number : exitCode

Holds the exit code returned by the application. (Read Only)

Since:

4.9.3.51

Number : logSize

Holds the size, in bytes, of the log file.

Attention:

The “-logSize #” option can used on the command line to specify the log size.

Since:

4.9.4.70

String : longVersionString

Holds a string representation of the full product version number; i.e., major.minor.revision.build. (Read Only)

String : orgName

Holds the name of the organization; i.e., “DAZ 3D”. (Read Only)

Since:

4.6.4.30

Array : scriptArgs

Holds the arguments passed to the application on launch. (Read Only)

Attention:

The “-scriptArg value” option can used on the command line to pass in a script argument.

Since:

4.9.3.39

String : systemLocaleName

Holds the name of the system locale in the form of a two-letter ISO 639 language code, followed by an underscore, followed by an uppercase two or three-letter ISO 3166 country code - e.g., en_US. (Read Only)

Since:

4.22.1.57

Number : version

Holds the full product version number as an encoded 32-bit integer. (Read Only) Deprecated

Use version64 instead.

Number : version64

Holds the full product version number as an encoded 64-bit integer. (Read Only)

String : versionString

Holds a string representation of the product version number; i.e., major.minor. (Read Only)

Static Methods

String : durationToString( Number mSecs, Boolean simplified=false, Boolean useLocale=true )

Parameter(s):

mSecs - The number of milliseconds to get a time string for.
simplified - Whether or not to simplify the string.
useLocale - If true, the return value will be in the system locale. If false, the return value will be suitable for logging.

Return Value:

A user readable string representing the time specified.

Since:

4.22.1.110

DzVersion : getPlatformVersion()

Return Value:

The current version of the Operating System for the platform.

Since:

4.15.0.22

DzVersion : getVersion()

Return Value:

The current version of the application.

Since:

4.11.0.230

Boolean : hasActiveModalWidget()

Return Value:

true if a modal widget (i.e., dialog) is currently displayed, otherwise false.

Example

(function(){
 
	print( App.hasActiveModalWidget() );
 
	var wDlg = new DzBasicDialog();
	App.postScriptEvent( true, "print( \"Testing:\", App.hasActiveModalWidget() );" );
	wDlg.exec();
 
})();

Since:

4.12.1.116

Methods

Number : bitArchitecture()

Return Value:

A numeric representation of the bit architecture the application was compiled for.

String : bitArchitectureString()

Return Value:

A user-friendly string representation of the bit architecture the application was compiled for.

String : byteSizeToString( Number bytes )

Parameter(s):

bytes - The numeric value to convert into a string.

Return Value:

A string representation of the byte size.

Example:

// The message will be written to the log
print( App.byteSizeToString( 1073741824 ) ); //1.0 GB

Boolean : canShowSceneBuilder( Object definition=undefined )

Parameter(s):

definition - If empty, the default SceneBuilder.json file (if any) in getResourcesPath() will be checked. If a string, the full path of a Scene Builder configuration file to check is expected. If an object, a map of Scene Builder configuration data is expected. (since 4.6.4.62)

Return Value:

true if the Scene Builder dialog would be displayed, otherwise false.

Since:

4.6.2.69

void : clearDelayedDeleteStack( Boolean doProgress )

Forces a deletion of all objects currently waiting to be deleted to free up more memory. If you are using this to clear memory you will generally want to clear the Undo Stack first.

See Also:

DzUndoStack::clearAll()

Parameter(s):

doProgress - If true, a progress dialog will be shown to the user while the operation is taking place.

void : clearPixmapCache()

Clears application wide cache of pixmaps.

Since:

4.11.0.34

Object : cpuInfo()

Return Value:

A map consisting of CPU information.

Since:

4.22.1.44

String : createDigest( Array tokens )

Parameter(s):

tokens - The list of strings to create a digest of.

Return Value:

A string representing a message digest. The string is formatted as 36 characters, in which 32 are hexadecimal and distributed across five groups of 8-4-4-4-12 separated by a hyphen ('-', i.e. “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx” where each 'x' is a hexadecimal digit).

String : createDigest( ByteArray data )

Parameter(s):

data - The byte array to create a digest of.

Return Value:

A string representing a message digest. The string is formatted as 36 characters, in which 32 are hexadecimal and distributed across five groups of 8-4-4-4-12 separated by a hyphen ('-', i.e. “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx” where each 'x' is a hexadecimal digit).

String : createUuid()

Return Value:

A string representing a randomly generated Universally Unique Identifier (UUID). The string is formatted as 38 characters, in which 32 are hexadecimal and distributed across five groups of 8-4-4-4-12 separated by a hyphen ('-') and enclosed by a pair of curly braces (i.e. “{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}” where each 'x' is a hexadecimal digit).

void : debug( String message )

Writes a debug message to the application log.

Parameter(s):

message - The message to write.

See Also:

writeToLog()
logSize
flushLogBuffer()

void : delayedExit( Number exitCode=0 )

Posts an event that causes the application to exit.

Parameter(s):

exitCode - The exit code to set. (since 4.9.3.51)

Since:

4.6.2.55

void : enableMultiThreading( Boolean onOff )

Parameter(s):

onOff - If true, multi-threaded features are enabled, otherwise multi-threaded features are disabled.

void : error( String message )

Writes an error message to the application log.

Parameter(s):

message - The message to write.

See Also:

writeToLog()
MessageError
logSize
flushLogBuffer()

Since:

4.16.1.26

void : fatal( String message )

Writes a fatal error message to the application log.

Parameter(s):

message - The message to write.

See Also:

writeToLog()
MessageFatal
logSize
flushLogBuffer()

Since:

4.16.1.26

Boolean : flushLogBuffer()

Writes any currently buffered log messages to the log file. This is automatically called whenever the log buffer has more than 512 characters of data, but can be called at any time to force all messages to be written out.

Return Value:

true if the log buffer was successfully flushed, otherwise false.

String : getAbsoluteScriptPath( String scriptName )

Searches in default locations for a script file of the given name.

Parameter(s):

scriptName - The name/path of a script file to find. This can be a file name, a relative file path, or an absolute file path.

Return Value:

The absolute path of the found script file (if any), otherwise an empty string.

See Also:

getGeneratedScriptsPath()
getScriptsPath()

String : getAppDataInstancePath()

Return Value:

The absolute path of the application data directory for the current machine user, the current major version, the current release cycle and the current instance of the application.

Attention:

This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

See Also:

getDAZDataPath()
getApplicationBaseName()
versionString
releaseCycleInstanceSuffix()

Since:

4.12.1.23

String : getAppDataPath()

Return Value:

The absolute path of the application data directory for the current machine user, the current major version and the current release cycle of the application.

Attention:

This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

See Also:

getDAZDataPath()
getApplicationBaseName()
versionString
releaseCycleSuffix()

String : getApplicationBaseName()

Return Value:

The base name of the application; e.g., “Studio”.

Since:

4.9.2.33

String : getApplicationDataName()

Return Value:

The name of the application settings; e.g., “Studio4 Public Build [1]”.

Since:

4.12.1.26

DzAssetIOMgr : getAssetIOMgr()

Return Value:

The application-wide Asset I/O Manager in charge of DAZ Scene Object Notation (DSON) format assets.

DzAssetMgr : getAssetMgr()

Return Value:

The application-wide Asset Manager.

DzAuthenticationMgr : getAuthenticationMgr()

Return Value:

The application-wide Authentication Manager - responsible for tracking user authentication.

DzCallBackMgr : getCallBackMgr()

Return Value:

The application-wide Call Back Manager - responsible for tracking call back objects.

String : getCloudLogFilename()

Return Value:

The filename for the file that logs messages from the application that pertains to the cloud service.

Since:

4.12.1.26

String : getCommonUserDocumentPath()

Return Value:

The absolute path of the public/shared user documents folder.

Attention:

This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

DzContentMgr : getContentMgr()

Return Value:

The application-wide Content Manager.

DzAuthor : getCurrentAuthor()

Return Value:

The current author (user that is currently running the app).

String : getDataFolderName()

Return Value:

The name of the data folder under the content directory.

String : getDataFolderPath()

Return Value:

The full path for the location where data is stored.

String : getDataFolderPathBase()

Return Value:

The base path for the location where data is stored.

String : getDAZDataPath()

Return Value:

The absolute path of the data directory for the organization.

Attention:

This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

See Also:

orgName

String : getDefaultTempPath()

Return Value:

The default absolute path of the directory where temporary files are stored.

See Also:

getAppDataInstancePath()
setTempPath()
getTempPath()
restoreDefaultTempPath()

Since:

4.20.1.77

DzDeviceMgr : getDeviceMgr()

Return Value:

The application-wide Device Manager - responsible for devices supported by the application.

QWidget : getDialogParent()

Return Value:

The active modal widget or the application main window if one exists.

String : getDocumentationPath()

Return Value:

The absolute path of the directory where application documentation files are stored.

See Also:

getHomePath()

String : getDocumentationUrl()

Return Value:

The online URL for application documentation.

Since:

4.22.1.208

String : getDocumentsPath()

Return Value:

The absolute path of the user documents folder for the application.

Attention:

This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

DzExportMgr : getExportMgr()

Return Value:

The application-wide Export Manager in charge of file exporters.

DzFileIOPresetMgr : getFileIOPresetMgr()

Return Value:

The application-wide File I/O Preset Manager.

String : getGeneratedScriptsPath()

Return Value:

The absolute path of the directory where support script files that are automatically generated are stored.

See Also:

getAppDataPath()

String : getGeneratedShadersPath()

Return Value:

The absolute path of the application data directory for automatically generated shaders.

See Also:

getAppDataPath()

GraphicsMode : getGraphicsMode()

Return Value:

An enumerated value representing the current graphics mode.

DzHelpMgr : getHelpMgr()

Return Value:

The application-wide Help Manager.

String : getHomePath()

Return Value:

The absolute path of the directory that contains the application executable.

DzImageMgr : getImageMgr()

Return Value:

The application-wide Image Manager - responsible for image I/O and tracking of currently loaded images.

DzImportMgr : getImportMgr()

Return Value:

The application-wide Import Manager in charge of file importers.

DzMainWindow : getInterface()

Return Value:

The main interface widget if the application is running with an interface, otherwise NULL.

See Also:

Global::MainWindow

String : getLoadSavePath()

Last directory that files were loaded or saved to/from.

See Also:

setLoadSavePath()

String : getLogFilename()

Return Value:

The filename for the file that logs messages from the application that pertains to the core application and any plugins.

See Also:

getCloudLogFilename()

Since:

4.12.1.26

DzMultiMediaMgr : getMultiMediaMgr()

Return Value:

The application-wide Video and Audio Manager - responsible for video and audio I/O.

DzPluginMgr : getPluginMgr()

Return Value:

The application-wide Plug-in Manager - responsible for tracking plug-ins.

String : getPluginsPath()

Return Value:

The absolute path of the base directory where plug-ins are loaded from.

See Also:

getHomePath()

String : getProgramDataAppInstancePath()

Return Value:

The absolute path of the machine's global program data directory for the organization, the current major version, the current release cycle, and the current instance of the application.

Attention:

This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

See Also:

getProgramDataPath()
getApplicationBaseName()
versionString
releaseCycleInstanceSuffix()

Since:

4.12.1.23

String : getProgramDataAppPath()

Return Value:

The absolute path of the machine's global program data directory for the organization, the current major version, and the current release cycle of the application.

Attention:

This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

See Also:

getProgramDataPath()
getApplicationBaseName()
versionString
releaseCycleSuffix()

String : getProgramDataPath()

Return Value:

The absolute path of the machine's global program data directory for the organization.

Attention:

This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

See Also:

orgName

DzRenderMgr : getRenderMgr()

Return Value:

The application-wide Render Manager.

String : getResourcesPath()

Return Value:

The absolute path of the directory where application resource files are stored.

See Also:

getHomePath()

String : getScriptsPath()

Return Value:

The absolute path of the directory where support script files are stored.

See Also:

getHomePath()

String : getShadersPath()

Return Value:

The absolute path of the base directory for all shaders.

See Also:

getHomePath()

DzSimulationMgr : getSimulationMgr()

Return Value:

The application-wide Simulation Manager.

Since:

4.9.3.140

DzStyle : getStyle()

Return Value:

The application-wide style object; subject to becoming invalid if the application style changes.

String : getStyleDefinition()

Return Value:

The name of the style definition currently in use.

Array : getStyleDefinitionList()

Return Value:

A list of the available style definitions.

String : getTempFilename()

Get a filename for temporary storage.

Return Value:

A unique filename (with no extension) whose path will be in the current temporary working folder.

Attention:

All files in this folder will be deleted when shutdown() is called.

String : getTempPath()

Return Value:

The absolute path of the directory where temporary files are stored.

See Also:

getDefaultTempPath()
setTempPath()
restoreDefaultTempPath()

String : getTempRenderFilename()

Get a filename for temporary storage of rendered images.

Return Value:

A filename (with no extension) whose path will be in the current temporary working folder.

Attention:

All files in this folder will be deleted when shutdown() is called.

String : getTempShadersPath()

Return Value:

The absolute path of the temporary directory for automatically generated shaders.

See Also:

getTempPath()

String : getUtilitiesPath()

Return Value:

The absolute path of the base directory for all binary utilities.

See Also:

getHomePath()

String : instanceName()

Return Value:

A user-friendly string indicating the name of the application instance (of the release cycle).

Attention:

The “-instanceName name” option can used on the command line to specify the name of the application instance. Valid characters for name include any uppercase or lowercase ASCII character in the A-Z range, as well as any number (integer), hyphen, underscore, in any sequence. Any characters that are not supported (e.g., a space - if the value is quoted, special characters, non-ASCII characters) will be automatically stripped. The name supports gap-filling automatic incrementation (Windows only - automatic incrementation does not currently occur on macOS). A name containing the “#” (number sign, hash, pound) character will automatically have occurrences of the “#” character replaced by the 'next' available incremental integer value (e.g., if instances 1, 2, and 3 are running, instance 2 is closed and a new instance is launched, the new instance will be assigned 2 and the next would be assigned 4 - unless 1, 2 or 3 were closed before it launched).

Since:

4.12.1.19

String : instanceNameSuffix()

Return Value:

A string indicating the name of the application instance (of the release cycle).

Since:

4.12.1.23

Boolean : isClosing()

Return Value:

true if the application is in the process of shutting down, otherwise false.

Boolean : isEmittingLogMessages()

Return Value:

true if the application should emit log messages, otherwise false.

Attention:

The “-noEmitLogMessages” option can used on the command line to suppress emitting of the fatalMessage(), errorMessage(), warningMessage(), infoMessage(), verboseMessage(), and debugMessage() signals.

Since:

4.16.1.26

Boolean : isKeyDown( Number key=-1 )

Parameter(s):

key - The Qt::Key value for the key to check. Since 4.11.0.263, any value < 0 (default) is interpreted as “any key” rather than a specific key.

Return Value:

true if key is currently pressed, otherwise false.

Boolean : isKeySequenceDown( String sequence=“Any” )

Parameter(s):

sequence - A string consistent with QKeySequence::fromString(), in the PortableText format. Since 4.11.0.263, “any” is interpreted as “any key” rather than a specific key sequence.

Return Value:

true if sequence is currently pressed, otherwise false.

Boolean : isMultiThreadingEnabled()

Return Value:

true if the user has chosen to enable multi-threaded features, otherwise false.

Boolean : isRegistered()

Return Value:

true if a valid serial number has been provided, otherwise false.

Boolean : isRunning()

Return Value:

true if the main event loop is running and events that are posted can be expected to be delivered, otherwise false.

Boolean : isSlave()

Return Value:

true if the application is running as a slave to another application, otherwise false.

Boolean : isStarting()

Return Value:

true if the application is in the process of starting up, otherwise false.

Boolean : isValidGuid( String data )

Parameter(s):

data - The string to test whether or not it is a valid GUID.

Return Value:

true if data consists of 32 hexadecimal characters (i.e. “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx” where 'x' represents a hexadecimal value in the range [0-9a-f]), or 36 characters in which 32 are hexadecimal values distributed across five groups of 8-4-4-4-12 separated by a hyphen ('-', i.e. “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”), or 38 characters where the previous description is enclosed by curly braces (i.e. “{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}”), otherwise false.

Since:

4.12.1.63

void : log( String message )

Writes a normal operational message to the application log.

Parameter(s):

message - The message to write.

See Also:

writeToLog()
MessageNormal
logSize
flushLogBuffer()

void : logMessageBox( String category, String title, String text, Array buttonTexts, Boolean immediate )

Writes a message containing information about a message box to the application log.

Parameter(s):

category - The category (if any) of the message to write.
title - The title if the message box.
text - The text of the message box.
buttonTexts - A list of the button texts for the message box.
immediate - If true, the message (and any others in the log buffer) will be immediately written to the log file. If false, the message will be written to the log buffer - the log buffer will be automatically flushed (written to file) if it exceeds the maximum defined buffer size.

See Also:

showPrompts()

Since:

4.16.1.26

void : logPathInfo( String label, String path )

Writes a message containing information about the specified path to the application log.

Parameter(s):

label - The label identifying the path.
path - The path to log information about.

Since:

4.15.0.30

Number : modifierKeyState()

Shift		   = 0x02000000
Control		 = 0x04000000 (Ctrl keys on a Windows keyboard, Command keys on a Macintosh keyboard)
Alt			 = 0x08000000
Meta			= 0x10000000 (Windows key on a Windows keyboard, Control keys on a Macintosh keyboard)
Keypad		  = 0x20000000

Return Value:

The current modifier key state; this value is a bitwise OR of the Qt::KeyboardModifier flags for the active keys (if any).

Example:

var bIsOSX = App.platform == DzApp.MacOSX;
var nModifiers = App.modifierKeyState();
var sStateValue = "0x" + nModifiers.toString( 16 ).toUpperCase();
var aKeys = [];
 
if( nModifiers & 0x02000000 ){
	aKeys.push( "Shift" );
}
 
if( nModifiers & 0x04000000 ){
	aKeys.push( bIsOSX ? "Command" : "Ctrl" );
}
 
if( nModifiers & 0x08000000 ){
	aKeys.push( "Alt" );
}
 
if( nModifiers & 0x10000000 ){
	aKeys.push( bIsOSX ? "Control" : "Windows" );
}
 
if( nModifiers & 0x20000000 ){
	aKeys.push( "Keypad" );
}
 
print( aKeys.join( " + " ), "=", sStateValue );

OperatingSystem : operatingSystem()

Return Value:

The enumerated value associated with the OperatingSystem that the application is running under.

String : operatingSystemString()

Return Value:

A user-readable string that describes the current Operating System.

Platform : platform()

The application is intended to be as platform independent as possible, but there are cases where something needs to be done differently on one platform or another. This function provides a simple way to check which platform the application is running under.

Return Value:

The enumerated value associated with the Platform that the application is running under.

Example:

var nPlatform = App.platform();
if( nPlatform == App.Windows ){
	//doWinSomething();
} else if( nPlatform == App.MacOSX ){
	//doMacSomething();
}

void : postScriptEvent( Boolean evaluate, String script, Array args=[] )

Posts an event that causes execution of a script as it is encountered in the event stack.

Parameter(s):

evaluate - If script is actual code, set this to true, otherwise set this to false.
script - This can be a file name, a relative file path, an absolute file path or code. If passed a file name or path, getAbsoluteScriptPath() is used to resolve it. If passed actual code, evaluate must also be set to true.
args - The list of arguments to pass to the script.

Since:

4.10.0.101

ReleaseCycle : releaseCycle()

Return Value:

The enumerated value associated with the ReleaseCycle of the application.

String : releaseCycleInstanceString()

Return Value:

A user-friendly string describing the release cycle (and optionally, the instance) of the application.

Since:

4.12.1.19

String : releaseCycleInstanceSuffix()

Return Value:

A user-friendly string describing the release cycle (and optionally, the instance) of the application.

Since:

4.12.1.19

String : releaseCycleInstanceSuffixStripped()

Return Value:

A string describing the release cycle (and optionally, the instance) of the application, without any space characters.

Since:

4.12.1.19

String : releaseCycleLocaleString()

Return Value:

A user-friendly string describing the release cycle of the application in the locale of the user interface.

Since:

4.22.1.57

String : releaseCycleString()

Return Value:

A user-friendly string describing the release cycle of the application.

String : releaseCycleSuffix()

Return Value:

A user-friendly string describing the release cycle of the application.

String : releaseCycleSuffixStripped()

Return Value:

A string describing the release cycle of the application, without any space characters.

ReleaseEdition : releaseEdition()

Return Value:

The enumerated value associated with the ReleaseEdition of the application.

String : releaseEditionLocaleString()

Return Value:

A user-friendly string describing the release edition of the application in the locale of the user interface.

Since:

4.22.1.57

String : releaseEditionString()

Return Value:

A user-friendly string describing the release edition of the application.

void : restoreDefaultTempPath()

Restores the temporary files directory to the default location.

See Also:

setTempPath()
getTempPath()
getDefaultTempPath()

void : setLoadSavePath( String path )

Sets the default directory for loading or saving files.

Parameter(s):

path - The absolute path of the (default) directory to load/save files from/to.

Example:

//Set the load/save path to our favorite folder
App.setLoadSavePath( "c:/MyScenes" );

See Also:

getLoadSavePath()

Boolean : setStyleDefinition( String name )

Sets the current style for the application.

Parameter(s):

name - The name of the style definition to use.

Return Value:

true if the application switched to the given style, otherwise false.

Boolean : setTempPath( String tempPath )

Sets the directory path where temporary files are stored. The path provided needs to be an absolute path. A directory will be created at the new location if it does not already exist.

Parameter(s):

tempPath - The path of the new temporary files directory.

Return Value:

true if the path provided is valid and changing the temporary path succeeded. false if any errors occurred.

See Also:

getTempPath()
restoreDefaultTempPath()

Boolean : showInNativeBrowser( String absFilePath )

A convenience method for opening a file/directory in the OS file browser.

Parameter(s):

absFilePath - The absolute file path of a file or folder to show.

Return Value:

true if the file exists and the OS file browser could be launched, otherwise false.

Boolean : showPrompts()

Return Value:

true if the application should prompt the user for input, otherwise false.

Attention:

The “-noPrompt” option can used on the command line to disable display of popup messages/dialogs - this feature is not strictly enforced and may not be fully implemented or necessarily respected by 3rd party plugins/scripts.

See Also:

Since:

4.9.3.46

Array : showSceneBuilder( Object definition=undefined, Boolean asEvent=false )

Displays the Scene Builder dialog.

Parameter(s):

definition - If empty, the default SceneBuilder.json file (if any) in getResourcesPath() will be used. If a string, the full path of a Scene Builder configuration file to check is expected. If an object, a map of Scene Builder configuration data is expected. (since 4.6.4.62)
asEvent - If false (default), the Scene Builder configuration data is processed immediately. If false, the Scene Builder configuration data is posted to an event and processed as it is encountered in the event stack. (since 4.6.4.62)

Return Value:

If asEvent is false, a list of the selections made by the user in the Scene Builder dialog, otherwise an empty list. (since 4.6.4.62)

See Also:

sceneBuilderRejected()
sceneBuilderAccepted()

Since:

4.6.2.69

void : showURL( String url )

A convenience method for browsing to a given URL.

Parameter(s):

url - The url to open in the system's default browser. Be sure to specify the scheme of the url (e.g., 'http:' or 'file:').

Example:

void : statusLine( String message, Boolean addToLog=true )

Display a message in the current status interface.

Parameter(s):

message - The string to be displayed.
addToLog - If true (default), the message will also be added to the application log.

Example:

//The message will be displayed in status bar and written to the log file
App.statusLine( "Hello World!" );

See Also:

writeToLog()

Boolean : usingInterface()

Return Value:

true if the application is using a user interface, otherwise false.

void : verbose( String message )

Writes a more verbose message to the application log.

Parameter(s):

message - The message to write.

See Also:

writeToLog()
MessageVerbose
logSize
flushLogBuffer()

Since:

4.16.1.26

void : warning( String message )

Writes a warning message to the application log.

Parameter(s):

message - The message to write.

See Also:

writeToLog()
MessageWarning
logSize
flushLogBuffer()

Boolean : writeConfigScript( String configScriptFilename=“” )

Saves out a user configuration script to the given filename. If no filename is given, the script is saved to the same file read from in startup(). The run() function calls this at the end of each execution.

Parameter(s):

filename - The name of the file to save a configuration script to. If empty (default), the default configuration script for the running application instance is used - i.e., getAppDataInstancePath() + '/' + “StartupScript.dsa” is used.

Return Value:

true if the file was written successfully, otherwise false.

void : writeToLog( String message )

Writes a message to the application log.

Parameter(s):

message - The message to write.

Example:

//The message will be written to the log
App.writeToLog( "Hello World!" );

See Also:

statusLine()

Since:

4.14.0.4

void : writeToLog( MessageSeverity severity, String category, String message, Boolean immediate )

Write a message to the application log.

Parameter(s):

severity - The severity of the message to log.
category - The category of the message to log.
message - The message to write.
immediate - If true, the message (and any others in the log buffer) will be immediately written to the log file. If false, the message will be written to the log buffer - the log buffer will be automatically flushed (written to file) if it exceeds the maximum defined buffer size.

Example:

//The message will be written to the log
App.writeToLog( DzApp.LogInfo, "Hello World!", "", true );

See Also:

flushLogBuffer()
logSize
statusLine()

Since:

4.16.1.26

void : writeToLog( String message, Boolean immediate )

Write a message to the application log.

Parameter(s):

message - The message to write.
immediate - If true, the message (and any others in the log buffer) will be immediately written to the log file. If false, the message will be written to the log buffer - the log buffer will be automatically flushed (written to file) if it exceeds the maximum defined buffer size.

Example:

//The message will be written to the log
App.writeToLog( "Hello World!", true );

See Also:

flushLogBuffer()
logSize
statusLine()

Since:

4.14.0.4

void : writeToLog( MessageSeverity severity, String message, Boolean immediate )

Write a message to the application log.

Parameter(s):

severity - The severity of the message to log.
message - The message to write.
immediate - If true, the message (and any others in the log buffer) will be immediately written to the log file. If false, the message will be written to the log buffer - the log buffer will be automatically flushed (written to file) if it exceeds the maximum defined buffer size.

Example:

//The message will be written to the log
App.writeToLog( DzApp.LogInfo, "Hello World!", true );

See Also:

flushLogBuffer()
logSize
statusLine()

Since:

4.16.1.26

DzSaveFilterMgr (deprecated) : getSaveFilterMgr()

Deprecated

Script based presets are deprecated in favor of those in the DAZ Scene Object Notation (DSON) format.

Return Value:

The application-wide Save Filter Manager in charge of script-based presets.

See Also:

getAssetIOMgr()

DzAppSettingsMgr : getAppSettingsMgr()

Deprecated

Exists only to keep old code working. Do not use in new code. Use DzAppSettings instead.

Return Value:

The application-wide persistent Settings Manager - used to set and retrieve application settings.

Signals

void : closing()

Signature:“closing()”

Emitted immediately after the main event loop exits.

void : debugMessage( String message, String category )

Signature:“debugMessage(const QString&,const QString&)”

Emitted when a debug message is sent to the application log.

Parameter(s):

message - The message that was sent.
category - The category for the message (if any).

See Also:

isEmittingLogMessages()

Since:

4.16.1.26

void : errorMessage( String message, String category )

Signature:“errorMessage(const QString&,const QString&)”

Emitted when an error message is sent to the application log.

Parameter(s):

message - The message that was sent.
category - The category for the message (if any).

See Also:

isEmittingLogMessages()

Since:

4.16.1.26

void : eventLoopStarted()

Signature:“eventLoopStarted()”

Emitted when the event loop is started on the application.

void : fatalMessage( String message, String category )

Signature:“fatalMessage(const QString&,const QString&)”

Emitted when a fatal message is sent to the application log.

Parameter(s):

message - The message that was sent.
category - The category for the message (if any).

See Also:

isEmittingLogMessages()

Since:

4.16.1.26

void : infoMessage( String message, String category )

Signature:“infoMessage(const QString&,const QString&)”

Emitted when a standard message is sent to the application log.

Parameter(s):

message - The message that was sent.
category - The category for the message (if any).

See Also:

isEmittingLogMessages()

Since:

4.16.1.26

void : mouseEvent()

Signature:“mouseEvent()”

Emitted when a MouseButtonDblClick or MouseButtonRelease event occurs on the application.

void : multiThreadingChanged( Boolean onOff )

Signature:“multiThreadingChanged(bool)”

Emitted when multi-threading has changed on the application.

void : sceneBuilderAccepted( Array selections )

Signature:“sceneBuilderAccepted(const QStringList&)”

Emitted when the Scene Builder dialog has been rejected by the user, or when none of the files specified in the Scene Builder definition can be found.

Since:

4.6.4.62

void : sceneBuilderRejected()

Signature:“sceneBuilderRejected()”

Emitted when the Scene Builder dialog has been rejected by the user, or when none of the files specified in the Scene Builder definition can be found.

Since:

4.6.4.62

void : starting()

Signature:“starting()”

Emitted after the application has finished its startup just before the main event loop begins.

void : styleAboutToChange()

Signature:“styleAboutToChange()”

Emitted when a the style is about to change on the application.

void : styleChanged( DzStyle newStyle )

Signature:“styleChanged(DzStyle*)”

Emitted when the application wide style has changed.

void : verboseMessage( String message, String category )

Signature:“verboseMessage(const QString&,const QString&)”

Emitted when a verbose message is sent to the application log.

Parameter(s):

message - The message that was sent.
category - The category for the message (if any).

See Also:

isEmittingLogMessages()

Since:

4.16.1.26

void : warningMessage( String message, String category )

Signature:“warningMessage(const QString&,const QString&)”

Emitted when a warning message is sent to the application log.

Parameter(s):

message - The message that was sent.
category - The category for the message (if any).

See Also:

isEmittingLogMessages()

Since:

4.16.1.26

void : debugMsg( String message )

Signature:“debugMsg(const QString&)”

Deprecated

Exists only to keep old scripts working. Do not use in new code. Use debugMessage() instead.

See Also:

isEmittingLogMessages()

void : warningMsg( String message )

Signature:“warningMsg(const QString&)”

Deprecated

Exists only to keep old scripts working. Do not use in new code. Use warningMessage() instead.

See Also:

isEmittingLogMessages()

DzAppSettings

2022-05-21T08:52:15+00:00

DzAppSettings

Provides cross-platform support for persistent application settings.

More...

Inherits :

QObject
- DzBase

Constructors

DAZ Script
DzAppSettings ()
DzAppSettings ( String startPath )

Methods

DAZ Script
Boolean	containsValue ( String key )
Boolean	getBoolValue ( String key, Boolean def=false )
Color	getColorValue ( String key, Color def=Color )
DzFloatColor	getFloatColorValue ( String key, DzFloatColor def=DzFloatColor )
Number	getFloatValue ( String key, Number def=0.0 )
Number	getIntValue ( String key, Number def=0 )
String	getStringValue ( String key, String def=“” )
void	popPath ()
void	pushPath ( String path )
Boolean	removeKey ( String key )
Boolean	removeValue ( String key )
Boolean	setBoolValue ( String key, Boolean setting )
Boolean	setColorValue ( String key, Color setting )
Boolean	setFloatColorValue ( String key, DzFloatColor setting )
Boolean	setFloatValue ( String key, Number setting )
Boolean	setIntValue ( String key, Number setting )
Boolean	setStringValue ( String key, String setting )

Detailed Description

Application Settings are used to store and retrieve settings that persist from one execution of the application to the next. On Windows, the settings are saved in the registry. On Mac, these settings are saved via Mac preference plist files.

You can create an instance of this class any time you need to read or write persistent settings. This class is a replacement for DzAppSettingsMgr as it is easier and safer to use. Since each instance is separate, the current path of one instance will not affect the rest of the application. It is also not necessary to call popPath() to put this class back into its previous state.

Constructors

DzAppSettings()

Default Constructor - creates a new settings object that starts out at the default application path.

DzAppSettings( String startPath )

Constructor - creates a new settings object that pushes the given path onto the default application path. This is the same as using the default constructor and then calling pushPath() with the given path.

Methods

Boolean : containsValue( String key )

Parameter(s):

key - The name of the value to check.

Return Value:

true if this settings contains the named value, otherwise false.

Boolean : getBoolValue( String key, Boolean def=false )

Read a boolean value from the given key.

Parameter(s):

key - The name of the value to read.
def - Default value - this value is returned if the named value fails to be read.

Return Value:

The value of the requested key.

See Also:

setBoolValue()

Color : getColorValue( String key, Color def=Color )

Read a color value from the given key.

Parameter(s):

key - The name of the value to read.
def - Default value - this value is returned if the named value fails to be read.

Return Value:

The value of the requested key.

See Also:

setColorValue()

DzFloatColor : getFloatColorValue( String key, DzFloatColor def=DzFloatColor )

Read a float color value from the given key.

Parameter(s):

key - The name of the value to read.
def - Default value - this value is returned if the named value fails to be read.

Return Value:

The value of the requested key.

See Also:

setColorValue()

Number : getFloatValue( String key, Number def=0.0 )

Read a floating point value from the given key.

Parameter(s):

key - The name of the value to read.
def - Default value - this value is returned if the named value fails to be read.

Return Value:

The value of the requested key.

See Also:

setFloatValue()

Number : getIntValue( String key, Number def=0 )

Read a integer value from the given key.

Parameter(s):

key - The name of the value to read.
def - Default value - this value is returned if the named value fails to be read.

Return Value:

The value of the requested key.

See Also:

setIntValue()

String : getStringValue( String key, String def=“” )

Read a string value from the given key.

Parameter(s):

key - The name of the value to read.
def - Default value - this value is returned if the named value fails to be read.

Return Value:

The value of the requested key.

See Also:

setStringValue()

void : popPath()

Pops a temporary key path off the top of the stack.

void : pushPath( String path )

Sets the current key path temporarily to the given path; popPath() can be called to remove this path.

Parameter(s):

path - The sub-path to add to the current key path.

Boolean : removeKey( String key )

Removes a key (and all values, sub-keys/ by name.

Parameter(s):

key - The name of the key to remove.

Since:

4.15.0.30

Boolean : removeValue( String key )

Removes a setting by name.

Parameter(s):

key - The name of the key to remove.

Return Value:

true if the key/value existed and was successfully removed, otherwise false.

Boolean : setBoolValue( String key, Boolean setting )

Sets a key with a boolean value.

Parameter(s):

key - The name of the key to write.
setting - The value to set.

Return Value:

true if the key/value was successfully set, otherwise false.

See Also:

getBoolValue()

Boolean : setColorValue( String key, Color setting )

Sets a key with a color value.

Parameter(s):

key - The name of the key to write.
setting - The value to set.

Return Value:

true if the key/value was successfully set, otherwise false.

See Also:

getColorValue()

Boolean : setFloatColorValue( String key, DzFloatColor setting )

Sets a key with a float color value.

Parameter(s):

key - The name of the key to write.
setting - The value to set.

Return Value:

true if the key/value was successfully set, otherwise false.

See Also:

getFloatColorValue()

Boolean : setFloatValue( String key, Number setting )

Sets a key with a floating point value.

Parameter(s):

key - The name of the key to write.
setting - The value to set.

Return Value:

true if the key/value was successfully set, otherwise false.

See Also:

getFloatValue()

Boolean : setIntValue( String key, Number setting )

Sets a key with a integer value.

Parameter(s):

key - The name of the key to write.
setting - The value to set.

Return Value:

true if the key/value was successfully set, otherwise false.

See Also:

getIntValue()

Boolean : setStringValue( String key, String setting )

Sets a key with a string value.

Parameter(s):

key - The name of the key to write.
setting - The value to set.

Return Value:

true if the key/value was successfully set, otherwise false.

See Also:

getStringValue()

Array

2021-07-02T19:55:13+00:00

Array

ECMAScript Array prototype object.

More...

Inherits :

Object

Properties

ECMAScript
Number	length

Static Methods

ECMAScript
Boolean	isArray ( Object obj )

Constructors

ECMAScript
Array ()
Array ( Object firstElement, … )
Array ( Number len )

Methods

ECMAScript
Array	concat ( Object element1, … )
Boolean	every ( Function callbackfn, Object thisArg=undefined )
Array	filter ( Function callbackfn, Object thisArg=undefined )
void	forEach ( Function callbackfn, Object thisArg=undefined )
Number	indexOf ( Object searchElement, Number fromIndex=0 )
String	join ( String separator=“,” )
Number	lastIndexOf ( Object searchElement, Number fromIndex=length-1 )
Array	map ( Function callbackfn, Object thisArg=undefined )
Object	pop ()
Number	push ( Object element1, … )
Object	reduce ( Function callbackfn, Object initialValue=undefined )
Object	reduceRight ( Function callbackfn, Object initialValue=undefined )
Array	reverse ()
Object	shift ()
Array	slice ( Number startIndex, Number endIndex=length )
Boolean	some ( Function callbackfn, Object thisArg=undefined )
Array	sort ( Function comparisonFunction )
Array	splice ( Number startIndex, Number deleteCount, … )
String	toLocaleString ()
String	toString ()
Number	unshift ( Object element1, … )
DAZ Script
Number	find ( Object element )
void	pushIfNotExists ( Object element1, … )

Detailed Description

An array is a data type that allows you to work with a list of elements. These elements can be any Object or QObject derived object. Multi-dimensional arrays are achieved by using array elements that are arrays themselves.

Array Creation

Arrays can be constructed using array literals, or by using the new operator. They can be extended dynamically by simply creating elements at non-existent index positions.

Example:

Array literal

var aTemp = [];

Example:

Array literal

var aTemp = [ "a", "b", "c", "d" ];

Example:

Using the new operator, initialized with a size, but with undefined elements

var aTemp = new Array( 4 );

Example:

Using the new operator, defining all elements

var aTemp = new Array( "a", "b", "c", "d" );

Example:

Multi-Dimensional, dynamically extended

var aTemp = [ "a", "b", "c", "d" ];
var aTemp2 = [];
 
for ( var i = 0; i < aTemp.length; i++ ) {
	aTemp2[ i ] = new Array( 2 );
	aTemp2[ i ][ 0 ] = i;
	aTemp2[ i ][ 1 ] = aTemp[ i ];
}
// aTemp2 == [ [ 0, "a" ], [ 1, "b" ], [ 2, "c" ], [ 3, "d" ] ]

Array Access

Array elements are accessed by their names. Names can be integers or strings. As integers, element names are zero-based, meaning the first element is at 0, the second element is at 1 and so on. As strings, elements can act as normal properties, and can be accessed by using the square bracket operator ([]) or by directly dereferencing the Array object and specifying the property name (.name). These two accessor types can be mixed freely.

Example:

Integer access

var aTemp = [ "a", "b", "c", "d" ];
var sTemp = aTemp[ 2 ];
// sTemp == "c";

Example:

Multi-Dimensional, integer access

var aTemp = [ [ "a", 5 ], [ "b", 10 ], [ "c", 15 ], [ "d", 20 ] ];
var nTemp = aTemp[ 2 ][ 1 ];
// nTemp == 15;

Example:

String access, using the square bracket operator

var aTemp = [];
 
// Assignment:
aTemp[ "one" ] = "a";
aTemp[ "two" ] = "b";
 
// Retrieval:
var sTemp = aTemp[ "one" ];
// sTemp == "a"
var sTemp2 = aTemp[ "two" ];
// sTemp2 == "b"

Example:

String access, dereferencing the Array, specifying properties

var aTemp = [];
 
// Assignment:
aTemp.one = "a";
aTemp.two = "b";
 
// Retrieval:
var sTemp = aTemp.one;
// sTemp == "a"
var sTemp2 = aTemp.two;
// sTemp2 == "b"

Array Iteration

An array can be iterated over by using a for or for...in loop.

Example:

Iteration of element names as integers, using the for control statement

var aTemp = [ "a", "b", "c", "d" ];
var sTemp = "";
 
for( var i = 0; i < aTemp.length; i++ ){
	sTemp += aTemp[ i ];
}
// sTemp == "abcd"

Example:

Iteration of element names as strings, using the for...in control statement.

var aTemp = [];
aTemp[ "first" ] = "a";
aTemp[ "second" ] = "b";
aTemp[ "third" ] = "c";
aTemp[ "fourth" ] = "d";
// element names are sorted alphanumerically
// aTemp == [ "first" : "a", "fourth" : "d", "second" : "b", "third" : "c" ]
 
var sTemp = "";
 
for( var sElement in aTemp ){
	sTemp += aTemp[ sElement ];
}
// sTemp == "adbc"

Todo

Investigate whether there is a (Qt) bug in the return value of reverse, sort and slice; reference vs. copy.

Properties

Number : length

Holds the number of elements in the array. (Read Only)

Example:

var aTemp = [ "a", "b", "c", "d" ];
print( aTemp.length ); //4

Static Methods

Boolean : isArray( Object obj )

Return Value:

true if obj is an array, otherwise false.

Example:

var aTemp = [];
print( Array.isArray( aTemp ) ); //true
 
var oTmp = {};
print( Array.isArray( oTmp ) ); //false

Constructors

Array()

Default Constructor.

Example:

var aTemp = new Array();
print( aTemp.length ); //0

Array( Object firstElement, … )

Constructs an array with one or more elements.

Parameter(s):

firstElement - The first element to add to the array.
… - Optional additional elements to add to the array.

Example:

var aTemp = new Array( "a", "b", "c", "d" );
print( aTemp.length ); //4

Array( Number len )

Constructs an array of the given length. The arrays elements will be uninitialized (undefined).

Parameter(s):

len - The number of items in the new array.

Example:

var aTemp = new Array( 10 );
print( aTemp.length ); //10

Methods

Array : concat( Object element1, … )

Parameter(s):

element1 - The first element to concatenate with the array.
… - Additional elements to concatenate with the array. (Optional)

Return Value:

A new array consisting of the concatenated contents.

Example:

var aTemp = [ "a", "b", "c" ];
print( aTemp ); //a,b,c
 
var nTemp = 5;
print( aTemp.concat( nTemp ) ); //a,b,c,5

var aTemp = [ "a", "b", "c" ];
print( aTemp ); //a,b,c
 
var aTemp2 = [ 1, 2, 3 ];
print( aTemp2 ); //1,2,3
 
print( aTemp.concat( aTemp2 ) ); //a,b,c,1,2,3

Boolean : every( Function callbackfn, Object thisArg=undefined )

Invokes a function for each non-empty element in the array, in ascending order, until or unless that function returns false.

Parameter(s):

callbackfn - A function that accepts 3 arguments and returns true or false; the arguments are the value of the element, the index of the element and the object being traversed
thisArg - An optional argument that defines the this value for each invocation of callbackfn.

Return Value:

true if callbackfn returns true for every element in the array, otherwise false.

Example:

function greaterThan5( nValue, nIndex, aValues ) {
	return nValue > 5;
}
 
function greaterThan10( nValue, nIndex, aValues ) {
	return nValue > 10;
}
 
var aTmp = [10, 20, 30, 40, 50];
print( aTmp.every( greaterThan5 ) ); //true
print( aTmp.every( greaterThan10 ) ); //false

Array : filter( Function callbackfn, Object thisArg=undefined )

Invokes a function for each non-empty element in the array.

Parameter(s):

callbackfn - A function that accepts 3 arguments and returns true or false; the arguments are the value of the element, the index of the element and the object being traversed.
thisArg - An optional argument that defines the this value for each invocation of callbackfn.

Return Value:

A new array of all the elements for which callbackfn returns true.

Example:

function evenNumber( nValue, nIndex, aValues ) {
	var nRemainder = nValue % 2;
	return nRemainder == 0;
}
 
function oddNumber( nValue, nIndex, aValues ) {
	var nRemainder = nValue % 2;
	return nRemainder == 1;
}
 
var aTemp = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
print( aTemp.filter( evenNumber ) ); //2,4,6,8,10
print( aTemp.filter( oddNumber ) ); //1,3,5,7,9

void : forEach( Function callbackfn, Object thisArg=undefined )

Invokes a function for each non-empty element in the array.

Parameter(s):

callbackfn - A function that accepts 3 arguments; the value of the element, the index of the element and the object being traversed.
thisArg - An optional argument that defines the this value for each invocation of callbackfn.

Example:

function printValue( nValue, nIndex, aValues ) {
	print( nIndex, nValue, aValues[ nIndex ] );
}
 
var aTemp = [10, 20, 30, 40, 50];
aTemp.forEach( printValue );
//0 10 10
//1 20 20
//2 30 30
//3 40 40
//4 50 50

Number : indexOf( Object searchElement, Number fromIndex=0 )

Compares searchElement to the elements of the array, in ascending order, using Strict Equals.

Parameter(s):

searchElement - The Object to search for.
fromIndex - An optional offset position within the array to begin searching from.

Return Value:

The index of the position of searchElement in the array, or -1 if searchElement is not found.

Example:

var aTemp = [ "a", "b", "c", "d" ];
print( aTemp.indexOf( "c" ) ); //2

String : join( String separator=“,” )

Parameter(s):

separator - The character used to separate the elements in the list.

Return Value:

A string containing all elements in the array, with the given separator between each.

Example:

var aTemp = [ "a", "b", "c", "d" ];
print( aTemp.join( ":" ) ); //a:b:c:d

See Also:

toString()

Number : lastIndexOf( Object searchElement, Number fromIndex=length-1 )

Compares searchElement to the elements of the array, in descending order, using strict equality.

Parameter(s):

searchElement - The Object to search for.
fromIndex - An optional offset position within the array to begin searching from.

Return Value:

The index of the position of searchElement in the array, or -1 if searchElement is not found.

Example:

var aTemp = [ "a", "b", "c", "d", "a", "b", "c", "d" ];
print( aTemp.lastIndexOf( "c" ) ); //6

Array : map( Function callbackfn, Object thisArg=undefined )

Invokes a function for each non-empty element in the array.

Parameter(s):

callbackfn - A function that accepts 3 arguments; the arguments are the value of the element, the index of the element and the object being traversed.
thisArg - An optional argument that defines the this value for each invocation of callbackfn.

Return Value:

A new array consisting of the results of calling callbackfn for each non-empty element in the array.

Example:

function addDoe( sValue, nIndex, aValues ) {
	return sValue + " Doe";
}
 
var aTemp = ["John", "Jane", "Baby"];
print( aTemp.map( addDoe ) ); //John Doe,Jane Doe,Baby Doe

Object : pop()

Removes the last (right-most) element from the array.

Return Value:

The removed element.

Example:

var aTemp = [ "a", "b", "c", "d" ];
print( aTemp ); //a,b,c,d
 
print( aTemp.pop() ); //d
print( aTemp ); //a,b,c

Number : push( Object element1, … )

Appends one or more elements onto the end (right) of the array.

Parameter(s):

element1 - The element to append.
… - Optional additional elements to append.

Return Value:

The new length of the array.

Example:

var aTemp = [ "a", "b", "c", "d" ];
print( aTemp ); //a,b,c,d
print( aTemp.push( "e" ) ); //a,b,c,d,e

Object : reduce( Function callbackfn, Object initialValue=undefined )

Invokes a function for each element in the array, in ascending order.

Parameter(s):

callbackfn - A function that accepts 4 arguments; the previousValue (or value from the previous call to callbackfn), the currentValue (value of the current element), the currentIndex and the object being traversed.
initialValue - An optional argument that defines the previousValue for initial invocation of callbackfn; if not defined previousValue will be the first element in the array and currentValue will be the second element.

Return Value:

A new Object consisting of the result of calling callbackfn for each element in the array.

Example:

function accumulate( nPreviousValue, nValue, nIndex, aValues ) {
	return nPreviousValue + nValue;
}
 
var aTemp = [10, 20, 30, 40, 50];
print( aTemp.reduce( accumulate, 5 ) ); //155

Object : reduceRight( Function callbackfn, Object initialValue=undefined )

Invokes a function for each element in the array, in descending order.

Parameter(s):

callbackfn - A function that accepts 4 arguments; the previousValue (or value from the previous call to callbackfn), the currentValue (value of the current element), the currentIndex and the object being traversed.
initialValue - An optional argument that defines the previousValue for initial invocation of callbackfn; if not defined previousValue will be the first element in the array and currentValue will be the second element.

Return Value:

A new Object consisting of the result of calling callbackfn for each element in the array.

Example:

function accumulate( nPreviousValue, nValue, nIndex, aValues ) {
	return nPreviousValue - nValue;
}
 
var aTemp = [10, 20, 30, 40, 50];
print( aTemp.reduceRight( accumulate, 155 ) ); //5

Array : reverse()

Reverses the order of the elements in the array.

Return Value:

A reference to the array.

Example:

var aTemp = [ "a", "b", "c", "d" ];
print( aTemp.reverse() ); //d,c,b,a

var aTemp = [ "a", "b", "c", "d" ];
print( aTemp ); //a,b,c,d
print( aTemp.reverse() ); //d,c,b,a

Object : shift()

Removes the first (left-most) element in the array.

Return Value:

The removed element.

Example:

var aTemp = [ "a", "b", "c", "d" ];
print( aTemp ); //a,b,c,d
 
var sTemp = aTemp.shift();
print( sTemp ); //a
print( aTemp ); //b,c,d

Array : slice( Number startIndex, Number endIndex=length )

Parameter(s):

startIndex - The index of the first element in the slice. If negative, the value is treated as length + startIndex, where length is the length of the array.
endIndex - The index of the element to end the slice at. Defaults to the length of the array. If negative, the value is treated as length + endIndex, where length is the length of the array. (Optional)

Return Value:

A copy of the array from the element at startIndex to (but not including) the element at endIndex.

Example:

var aTemp = [ "a", "b", "c", "d", "e", "f" ];
var aTemp2 = aTemp.slice( 2 );
print( aTemp ); //a,b,c,d,e,f
print( aTemp2 ); //c,d,e,f

var aTemp = [ "a", "b", "c", "d", "e", "f" ];
var aTemp2 = aTemp.slice( 1, 4 );
print( aTemp ); //a,b,c,d,e,f
print( aTemp2 ); //b,c,d

Boolean : some( Function callbackfn, Object thisArg=undefined )

Invokes a function for each non-empty element in the array, in ascending order.

Parameter(s):

callbackfn - A function that accepts 3 arguments and returns true or false; the arguments are the value of the element, the index of the element and the object being traversed.
thisArg - An optional argument that defines the this value for each invocation of callbackfn.

Return Value:

true if callbackfn returns true for any element in the array, otherwise false.

Array : sort( Function comparisonFunction )

Sorts the array using comparisonFunction. If no Function is provided, default sorting is applied.

Parameter(s):

comparisonFunction - An optional function to call to compare items in the array.

Return Value:

A reference to the array.

Example:

No arguments

var aTemp = new [ "a", "c", "d", "b" ];
aTemp.sort();
// aTemp == [ "a", "b", "c", "d" ]

Example:

Comparison function

// -1 if a < b, 0 if a == b, 1 if a > b
function numerically( a, b ){
	return a < b ? -1 : a > b ? 1 : 0;
}
 
var aTemp = [ 8, 90, 1, 4, 843, 221 ];
aTemp.sort( numerically );
// aTemp == [ 1, 4, 8, 90, 221, 843 ]

Array : splice( Number startIndex, Number deleteCount, … )

Splices elements into the array.

Parameter(s):

startIndex - The index in the array to place the new element(s).
deleteCount - The number of elements in the array to delete.
… - Optional element(s) to insert into the array.

Return Value:

An array containing the deleted elements (if any).

Example:

Insert

var aTemp = [ "a", "b", "c", "d" ];
aTemp.splice( 2, 0, "X" );
print( aTemp ); //a,b,X,c,d

var aTemp = [ "a", "b", "c", "d" ];
aTemp.splice( 2, 0, "X", "Y" );
print( aTemp ); //a,b,X,Y,c,d

Example:

Remove

var aTemp = [ "a", "b", "c", "d" ];
var aTemp2 = aTemp.splice( 2, 1 );
print( aTemp ); //a,b,d
print( aTemp2 ); //c

Example:

Replace

var aTemp = [ "a", "b", "c", "d" ];
var aTemp2 = aTemp.splice( 2, 1, "X" );
print( aTemp ); //a,b,X,d
print( aTemp2 ); //c

var aTemp = [ "a", "b", "c", "d" ];
var aTemp2 = aTemp.splice( 2, 1, "X", "Y" );
print( aTemp ); //a,b,X,Y,d
print( aTemp2 ); //c

String : toLocaleString()

Provides a locale-aware version of toString().

Return Value:

A string containing all elements of an array together, separated by a locale-specific separator.

See Also:

toString(), join()

String : toString()

Return Value:

A string containing all elements of an array together, separated by commas. This method is used when the array is used in the context of string concatenation or is used as a text value (e.g. for printing).

Example:

var aTemp = [ "a", "b", "c", "d" ];
var sTemp = aTemp.toString();
// sTemp == "a,b,c,d"

See Also:

join()

Number : unshift( Object element1, … )

Inserts the element(s) at the beginning (left) of the array.

Parameter(s):

element1 - The first element to insert into the array.
… - Optional additional element(s) to insert into the array.

Return Value:

The number of objects in the array.

Example:

var aTemp = [ "a", "b", "c", "d" ];
var nTemp = aTemp.unshift( "X" );
print( aTemp ); //X,a,b,c,d
print( nTemp ); //5

var aTemp = [ "a", "b", "c", "d" ];
var nTemp = aTemp.unshift( "X", "Y" );
print( aTemp ); //X,Y,a,b,c,d
print( nTemp ); //6

Number : find( Object element )

Parameter(s):

element - The item to search for in the array.

Return Value:

The index of element, if found. -1 if element is not found.

Example:

var aTemp = [ "a", "b", "c", "d", "e" ];
print( aTemp.find( "d" ) ); //3

void : pushIfNotExists( Object element1, … )

Pushes one or more elements onto the end (right) of the array, if it does not already exist in the array.

Parameter(s):

element1 - The first element to append to the array.
… - Optional additional element(s) to insert into the array.

Example:

var aTemp = [ "a", "b", "c", "d" ];
aTemp.pushIfNotExists( "e" );
// aTemp == [ "a", "b", "c", "d", "e" ]

DzArrayHelper

2017-09-11T05:28:00+00:00

DzArrayHelper

Convenience object to make working with an Array object easier.

More...

Inherits :

QObject

Constructors

DAZ Script
DzArrayHelper ()

Methods

DAZ Script
Array	addToArray ( Array list, Object value )
Number	isInArray ( Array list, Object value )
Number	isInArrayByName ( Array list, Object obj )

Detailed Description

TODO: Add detailed description.

Constructors

DzArrayHelper()

Default Constructor

Methods

Array : addToArray( Array list, Object value )

Parameter(s):

list - The Array to append object to
value - The Object to append to list

Return Value:

A copy of list with object appended if object did not already exist in list

Number : isInArray( Array list, Object value )

Parameter(s):

list - The Array to check for object
value - The Object to check list for

Return Value:

The index into list if object was found, otherwise -1

Number : isInArrayByName( Array list, Object obj )

Parameter(s):

list - The Array to check for object
value - The Object to check list for; using the objects .name property

Return Value:

The index into list if object was found, otherwise -1

DzAsset

2024-11-11T00:47:58+00:00

DzAsset

An abstraction between the presentation of a content file and the file on disk.

More...

Inherits :

Inherited By : DzNotInstalledProductAsset

Properties

DAZ Script
Object	assetID
String	assetName
Number	audience
Array	categories
Boolean	companionIsScript
String	companionPath
Array	compatibilities
String	compatibilityBase
String	contentType
Date	dateCreated
Date	dateLastModified
String	description
String	displayName
Number	groupId
Boolean	hasCloudMetadata
Boolean	hasCompanion
Boolean	hasCompanionScript
Boolean	hidden
Pixmap	icon
Boolean	isCloudInstallable
Boolean	isCloudInstalled
Boolean	isCloudOwned
Boolean	isInstalled
Boolean	isMetadataValid
Boolean	isNative
Boolean	isScript
Boolean	isSymLink
Boolean	isVendor
Boolean	needsCloudInstall
Boolean	needsCloudUpdate
String	notes
String	originalFilename
String	originalPath
String	productGUID
String	productID
String	productName
String	productPath
Pixmap	smallIcon
String	storeID
String	symLinkPath
String	url
String	urlEncoded
Array	userCategories
Array	userCompatibilities
Array	userKeywords
Array	vendorCategories
Array	vendorCompatibilities
Array	vendorKeywords

Methods

DAZ Script
void	addCompatibilities ( Array bases, Boolean create=false )
void	addToCategories ( Array categories, Boolean create=false )
void	clearGroup ()
void	forceImageReload ()
String	getAsLocalFile ()
String	getBaseExtension ()
String	getDSLinkExtension ()
String	getDSLinkText ()
DzAbstractAssetContainer	getOwner ()
DzProductAssetContainer	getProduct ()
String	getRelativeFilePath ()
Boolean	isGroup ( Number id )
Boolean	loadDefaultIcon ( Boolean delayLoad )
Object	readLinkData ( String linkPath )
void	removeCompatibilities ( Array bases, Boolean isVender=false )
void	removeFromCategories ( Array categories, Boolean isVender=false )
Boolean	rename ( String name )
Boolean	saveDSLink ( String linkSavePath )
void	setIgnoreExists ( Boolean onOff )
DzUri	toUri ()
Boolean	updateFromMetadata ( String guid=“” )

Signals

void	assetImageChanged ( DzAsset asset )

Detailed Description

An “Asset” serves as an abstraction between the presentation of a content file and the actual file that resides on disk; it is a “container” for information about a content file.

At a minimum, an asset contains a reference to the relative path and filename of a file.

Metadata

When the Content Management System (CMS) is active, an asset provides an interface to its metadata within the content database. This metadata includes information such as what type of asset it is, what it is used for, what it is compatible with, which category(ies) it is presented to the user in, etc.

Conceptually, each asset belongs to exactly one “Product”. By default, and until/unless modified, all newly created assets are assigned to the “LOCAL USER” product. An asset is uniquely identified within a product by the combination of its relative path and filename. While any number of products can reference a file with the same relative path and filename combination, each product's concept of that combination is unique (even if their metadata is identical).

The metadata for a given asset is divided into 2 distinct types; that which is owned and/or maintained by the vendor (the originating source), and that which is owned and/or maintained by the end-user. Unless the metadata component (e.g., userKeywords, userNotes, etc), the product (e.g., “LOCAL USER”), or the store (e.g., “LOCAL USER”) indicate “user” in their name, any assumption (if there is to be one) about which type the data is should be that which is owned and/or maintained by the vendor.

The metadata for an asset that is “installed” and which belongs to a product associated with a “Store” (source) other than the “LOCAL USER” store is owned by the vendor. Conversely, the metadata for an asset that is created by the user and/or belongs to a product associated with the “LOCAL USER” store is owned by the user. The exceptions to this are those attributes which integrate “user” into their name; which in fact always belong to the user.

The significance of the distinction between the 2 types of metadata comes down to how the data is handled during an update and whether or not an effort is made to preserve it. Metadata that is owned and/or maintained by the vendor can be summarily purged during an update. This provides a vendor with the means to clean up all potential prior versions of the metadata without being faced with complex bookkeeping tasks.

See Also:

Properties

Object : assetID

Holds the asset identifier for this asset. (Read Only)

String : assetName

Holds the name for this asset. (Read Only)

Number : audience

Holds the vendor intended audience for this asset.

Since:

4.8.1.97

Array : categories

Holds a list of all categories that this asset is in. (Read Only)

Since:

4.9.0.2

Boolean : companionIsScript

Holds whether the companion file (if any) is a DAZ Script. (Read Only)

String : companionPath

Holds the full path to the folder the companion file is in. (Read Only)

Array : compatibilities

Holds a list of all compatibility bases that this asset is compatible with. (Read Only)

Since:

4.9.0.2

String : compatibilityBase

Holds the [vendor] compatibility base for this asset.

Since:

4.8.1.97

String : contentType

Holds the [vendor] content type for this asset.

Since:

4.8.1.97

Date : dateCreated

Holds the date this asset was created. (Read Only)

Since:

4.9.0.2

Date : dateLastModified

Holds the date this asset was last modified. (Read Only)

Since:

4.9.0.2

String : description

Holds the vendor description for this asset.

Since:

4.8.1.97

String : displayName

Holds the name displayed to the user for this asset. (Read Only)

Since:

4.9.0.20

Number : groupId

Holds the group identifier for this asset. 0 = default, < 0 = app defined, > 0 = user defined.

Since:

4.9.0.11

Boolean : hasCloudMetadata

Holds whether this asset has metadata provided by the cloud. (Read Only)

Since:

4.9.0.2

Return Value:

true if metadata for this asset came from the cloud, otherwise false.

Since:

4.9.0.2

Boolean : hasCompanion

Holds whether this asset is a non-native file and a DAZ Script or native file with the same basename exists in the same directory. (Read Only)

Boolean : hasCompanionScript

Holds whether this asset is a non-native file and a DAZ Script with the same basename exists in the same directory. (Read Only)

Boolean : hidden

Holds whether this asset should be hidden in asset views.

Since:

4.9.0.2

Pixmap : icon

Holds the icon path for this asset. (Read Only)

Boolean : isCloudInstallable

Holds whether this asset can be installed from the cloud. (Read Only)

Since:

4.9.0.20

Boolean : isCloudInstalled

Holds whether this asset is installed from the cloud. (Read Only)

Since:

4.9.0.20

Boolean : isCloudOwned

Holds whether this asset is managed by the cloud. (Read Only)

Since:

4.9.0.2

Return Value:

true if this asset is installed by the cloud, otherwise false.

Since:

4.9.0.2

Boolean : isInstalled

Holds whether this asset is installed in the database. (Read Only)

Since:

4.9.0.20

Boolean : isMetadataValid

Holds whether the metadata for this asset is valid. (Read Only)

Since:

4.9.0.2

Return Value:

true if the metadata is valid, otherwise false.

Since:

4.8.1.97

Boolean : isNative

Holds whether this asset is a native file. (Read Only)

Boolean : isScript

Holds whether this asset is a native script file. (Read Only)

Boolean : isSymLink

Holds whether this asset is a symbolic link. (Read Only)

Return Value:

true if this asset is a symbolic link, otherwisefalse.

Boolean : isVendor

Holds whether this asset is owned by a vendor or by the user. (Read Only)

Since:

4.9.0.2

Boolean : needsCloudInstall

Holds whether this asset needs to be installed from the cloud. (Read Only)

Since:

4.9.0.20

Boolean : needsCloudUpdate

Holds whether this asset needs to be updated from the cloud. (Read Only)

Since:

4.9.0.2

Return Value:

true if this asset has an update available from the cloud, otherwise false.

Since:

4.9.0.2

String : notes

Holds the user notes for this asset.

Since:

4.12.2.15

String : originalFilename

Holds the original filename for this asset. (Read Only)

Since:

4.8.1.97

String : originalPath

Holds the original path for this asset. (Read Only)

Since:

4.8.1.97

String : productGUID

Holds the Globally Unique Identifier (GUID) for the product this asset belongs to. (Read Only)

Since:

4.11.0.193

String : productID

Holds the product identifier for the product that this asset belongs to. (Read Only)

Since:

4.9.0.55

String : productName

Holds the name of the product this asset belongs to. (Read Only)

Since:

4.9.0.55

String : productPath

Holds the base of the product path in the cloud folder for cloud assets. (Read Only)

Since:

4.9.3.83

Pixmap : smallIcon

Holds the icon path for this asset. (Read Only)

String : storeID

Holds the store identifier for the product that this asset belongs to. (Read Only)

Since:

4.11.0.193

String : symLinkPath

Holds the path that the symbolic link is referencing (if any).

String : url

Holds the URL for this asset. (Read Only)

String : urlEncoded

Holds the encoded URL for this asset. (Read Only)

Array : userCategories

Holds a list of user owned categories that this asset is in. (Read Only)

Since:

4.9.0.2

Array : userCompatibilities

Holds a list of user owned compatibility bases that this asset is compatible with. (Read Only)

Since:

4.9.0.2

Array : userKeywords

Holds the user keywords for this asset.

Since:

4.9.0.2

Array : vendorCategories

Holds a list of vendor owned categories that this asset is in. (Read Only)

Since:

4.9.0.2

Array : vendorCompatibilities

Holds a list of vendor owned compatibility bases that this asset is compatible with. (Read Only)

Since:

4.9.0.2

Array : vendorKeywords

Holds the vendor keywords for this asset.

Since:

4.9.0.2

Methods

void : addCompatibilities( Array bases, Boolean create=false )

Sets the compatibility bases that this asset is compatible with.

Parameter(s):

bases - The list of compatibility bases this asset is compatible with.
create - If true, creates compatibility bases that do not exist. If false, compatibility will only be established for compatibility bases that already exist.

Since:

4.9.0.2

void : addToCategories( Array categories, Boolean create=false )

Sets the categories for this asset.

Parameter(s):

categories - The list of categories to add this asset to.
create - If true, creates categories that do not exist. If false, only categories that already exist will be assigned.

Since:

4.9.0.2

void : clearGroup()

Sets this asset as belonging to the default group identifier; 0.

Since:

4.9.0.11

void : forceImageReload()

Forces the icon for this asset to reload.

String : getAsLocalFile()

Return Value:

The url of this asset as a local file path.

String : getBaseExtension()

Return Value:

The base file extension for this asset; without any encryption extension.

String : getDSLinkExtension()

Return Value:

The extension to use for DAZ Studio file link.

Since:

4.9.0.30

String : getDSLinkText()

Return Value:

The text that is placed inside a DAZ Studio file link.

Since:

4.9.0.30

DzAbstractAssetContainer : getOwner()

Return Value:

The asset container that owns this asset.

See Also:

DzScriptHandle

DzProductAssetContainer : getProduct()

Return Value:

The product that this asset belongs to (if any), otherwise null.

See Also:

DzScriptHandle

Since:

4.9.0.2

String : getRelativeFilePath()

Return Value:

The relative file path for this asset.

Boolean : isGroup( Number id )

Return Value:

true if this asset is a member of group, otherwise false.

Attention:

0 = default, < 0 = app defined, > 0 = user defined

Since:

4.9.0.11

Boolean : loadDefaultIcon( Boolean delayLoad )

Loads the default icon for this asset.

Parameter(s):

delayLoad - If true, loading of the icon is delayed.

Return Value:

true if the default icon for this asset is successfully loaded, otherwise false.

Object : readLinkData( String linkPath )

Parameter(s):

linkPath - The path of the file to read from.

Return Value:

A map of the key value pairs in a DAZ Studio link file.

Since:

4.9.0.30

void : removeCompatibilities( Array bases, Boolean isVender=false )

Removes the compatibility bases that this asset is compatible with.

Parameter(s):

bases - The list of compatibilities to remove from this asset.
isVender - If true, the compatibilities being looked up are owned by the vendor.

Since:

4.9.2.53

void : removeFromCategories( Array categories, Boolean isVender=false )

Removes this asset from the categories.

Parameter(s):

categories - The list of categories to remove this asset from.
isVender - If true, the categories being looked up are owned by the vendor.

Since:

4.9.2.53

Boolean : rename( String name )

Changes the name of this asset.

Parameter(s):

name - The new name for this asset.

Return Value:

true if the operation is successful, otherwise false.

Boolean : saveDSLink( String linkSavePath )

Parameter(s):

linkSavePath - The path of the file to save to.

Return Value:

true if a DAZ Studio file link to this asset is saved, otherwise false.

Attention:

Will overwrite and add correct extension if possible.

Since:

4.9.0.30

void : setIgnoreExists( Boolean onOff )

Sets whether existence of this asset should be ignored.

DzUri : toUri()

Return Value:

This asset expressed as a DzUri.

Since:

4.9.0.40

Boolean : updateFromMetadata( String guid=“” )

Parameter(s):

guid - The Globally Unique Identifier (GUID) for the product to update from. Leave empty to update using the current product if an association is already made.

Return Value:

true if this asset is updated, otherwise false.

Since:

4.9.2.69

Signals

void : assetImageChanged( DzAsset asset )

Signature:“assetImageChanged(DzAsset*)”

Emitted when the image for this asset has changed.

Parameter(s):

asset - The asset that the image changed on.

DzAssetFileOutFilter

2024-11-11T00:41:50+00:00

DzAssetFileOutFilter

Detailed Description

An asset save filter for saving a file in the DSON format.

DzAssetIOFilter

2024-11-10T17:39:13+00:00

DzAssetIOFilter

Base class for filters that save DSON-based scene settings.

More...

Inherits :

QObject
- DzBase
  - DzFileIO

Inherited By : DzAssetFileOutFilter

Methods

DAZ Script
DzError	doSave ( String filename, String startingDir )
DzError	doSave ( DzFileIOSettings options, String filename, String startingDir )
DzUri	getAssetDefinitionUri ( DzBase base )
DzUri	getAssetInstanceUri ( DzBase base )
String	getCompatiblityBase ()
String	getContentType ()
String	getDescription ()
String	getDoSavePath ()
String	getLoadSavePath ()
String	getSettingsPath ()
String	getStandardSaveRelativePath ()
Boolean	isSupportAssetFilter ()
void	setLoadSavePath ( String path )

Detailed Description

Save filter classes save out a subset of scene settings such as poses, light sets, camera sets, etc. in the DSON format.

See Also:

DzAssetIOMgr
Samples: Save Filters

Methods

DzError : doSave( String filename, String startingDir )

Saves to a file.

Parameter(s):

filePath - The full path of the file to save to.
startingDir - The initial directory to start the save dialog in.

Return Value:

DZ_NO_ERROR on success, otherwise an error code.

DzError : doSave( DzFileIOSettings options, String filename, String startingDir )

Saves to a file.

Parameter(s):

options - The options for the save.
filePath - The path of the file to save to.
startingDir - The initial directory to start the file browse.

Return Value:

DZ_NO_ERROR on success, otherwise an error code.

See Also:

Samples: Save Filters

DzUri : getAssetDefinitionUri( DzBase base )

Return Value:

The URI to use when referring to the given asset from a definition.

DzUri : getAssetInstanceUri( DzBase base )

Return Value:

The URI to use when referring to the given asset from an instance.

String : getCompatiblityBase()

Return Value:

The compatibility base of the saved file.

String : getContentType()

Return Value:

The content type of the saved file.

String : getDescription()

Return Value:

The name of the filter.

String : getDoSavePath()

Return Value:

The path of the saved file.

String : getLoadSavePath()

Return Value:

The last path used to load/save files with the filter.

String : getSettingsPath()

Return Value:

The path to use for settings of this filter.

Since:

4.21.1.7

String : getStandardSaveRelativePath()

Return Value:

The default relative path for saving files with this filter.

Boolean : isSupportAssetFilter()

Return Value:

true if this filter saves support files, otherwise false.

void : setLoadSavePath( String path )

Sets the path to use for loading/saving files with this filter.

Parameter(s):

path - The path to set.

DzAssetIOFilterAction

2024-11-11T00:41:39+00:00

DzAssetIOFilterAction

Class for actions that activate a save filter.

DzAssetIOFilterAction subclasses are automatically added to the main menu under 'File > Save As'.

More...

Inherits :

QObject
- DzAction

Detailed Description

TODO: Add detailed description.

DzAssetIOMgr

2022-05-24T21:43:35+00:00

DzAssetIOMgr

Manager responsible for the asset filters that load/save DSON files.

More...

Inherits :

QObject

Enumerations

DAZ Script
DzOpenMethod	{ DefaultMethod, OpenNew, MergeFile }

Static Methods

DAZ Script
DzAssetIOFilter	currentSaveFilter ()
Number	findAssetFilterIndex ( String className )
Number	findFilter ( String className )
QObject	findObjectInstance ( DzUri uri )
DzAssetIOFilter	getAssetFilter ( Number i )
String	getAssetFilterName ( Number i )
DzAssetIOFilter	getFilter ( Number i )
String	getFilterName ( Number i )
Number	getNumAssetFilters ()
Number	getNumFilters ()
Boolean	isReading ()
Boolean	isReadingOrWriting ()
Boolean	isWriting ()

Methods

DAZ Script
DzError	doLoad ( String filename, DzOpenMethod method=DefaultMethod, DzFileLoadFilter filter=null )
DzError	doSave ( Number filterIndex )
DzError	doSaveWithOptions ( DzAssetIOFilter filter, DzFileIOSettings options, Boolean saveOnly=false, String filename=“”, String startingDir=“”, String category=“” )
DzError	doSceneSaveAs ()
DzAuthor	getCurrentAssetContributor ()
String	getCurrentAssetId ()
DzVersion	getCurrentAssetRevision ()
String	getCurrentAssetType ()
Object	getCurrentFileInfo ()
String	getCurrentFilename ()
DzVersion	getCurrentFileVersion ()
String	getDefaultDSONAssetCachePath ()
String	getDSONAssetCachePath ()
DzAuthor	getFileAssetContributor ( String filename )
String	getFileAssetType ( String filename )
Object	getFileInfo ( String filename )
DzVersion	getFileVersion ( String filename )
String	getLoadPath ()
String	getSavePath ()
DzError	loadFromUri ( DzUri fileUri, DzOpenMethod method=DefaultMethod, DzFileLoadFilter filter=null )
void	setDSONAssetCachePath ( String cacheFullPath )

Signals

void	assetImported ()
void	assetImportStarting ()
void	assetLoadError ( String filename )
void	assetLoadFinished ( String filename )
void	assetLoadStarted ( String filename )
void	assetSaved ()
void	assetSaveError ( String filename )
void	assetSaveFinished ( String filename )
void	assetSaveStarted ( String filename )

Detailed Description

Responsible for the management of the filters that load/save assets in the native DAZ Scene Object Notation (DSON) format.

There is only one instance of this manager in an application. This instance is created and owned by DzApp. Request the instance via DzApp::getAssetIOMgr().

See Also:

Global::App
Samples: Save Filters

Enumerations

: DzOpenMethod

Enumerated open methods.

DefaultMethod - If no nodes (or only the default camera) exist, this behaves as OpenNew. Otherwise, this behaves as MergeFile.
OpenNew - Resets the scene to its initial, clean state. All scene data is deleted and the undo stack is cleared.
MergeFile - Merges the file with any pre-existing elements in the scene.

Static Methods

DzAssetIOFilter : currentSaveFilter()

Return Value:

The current save filter (if any), otherwise null.

Since:

4.15.0.16

Number : findAssetFilterIndex( String className )

Parameter(s):

className - The classname of the asset filter to find.

Return Value:

The index of the asset filter with the given classname (if any), otherwise -1.

Since:

4.11.0.225

Number : findFilter( String className )

Deprecated

Exists only to keep old code working. Do not use in new code. Use getAssetFilter() instead.

QObject : findObjectInstance( DzUri uri )

Parameter(s):

uri - The URI of an asset instance to find during file load.

Return Value:

The object for the specified URI (if any), otherwise null.

Since:

4.9.4.111

DzAssetIOFilter : getAssetFilter( Number i )

Parameter(s):

i - The index of the asset filter to get.

Return Value:

A new instance of the i'th asset filter in the list (if valid), otherwise null.

Attention:

You are responsible for deleting the returned instance (if any).

Since:

4.11.0.225

String : getAssetFilterName( Number i )

Parameter(s):

i - The index of the asset filter to get the name of.

Return Value:

The name of the i'th asset filter (if valid), otherwise an empty string.

Since:

4.11.0.225

DzAssetIOFilter : getFilter( Number i )

Deprecated

Exists only to keep old code working. Do not use in new code. Use getAssetFilter() instead.

String : getFilterName( Number i )

Deprecated

Exists only to keep old code working. Do not use in new code. Use getAssetFilterName() instead.

Number : getNumAssetFilters()

Return Value:

The number of save filters currently supported.

Since:

4.11.0.225

Number : getNumFilters()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getNumAssetFilters() instead.

Boolean : isReading()

Return Value:

if data is currently being read, otherwise false.

Since:

4.15.0.16

Boolean : isReadingOrWriting()

Return Value:

if data is currently being read or written, otherwise false.

Since:

4.15.0.16

Boolean : isWriting()

Return Value:

if data is currently being written, otherwise false.

Since:

4.15.0.16

Methods

DzError : doLoad( String filename, DzOpenMethod method=DefaultMethod, DzFileLoadFilter filter=null )

Loads an asset file.

Parameter(s):

filename - The full name of the file to load.
method - The method to use for loading.
filter - The filter to use.

Return Value:

DZ_NO_ERROR if the file load was successful, otherwise an appropriate error code.

See Also:

DzUri::fromLocalFilename()
loadFromUri()

DzError : doSave( Number filterIndex )

Save the scene contents to a file with the given asset filter. Prompts the user for a file to save to.

Parameter(s):

filterIndex - The index of the asset filter to use.

Return Value:

DZ_NO_ERROR if the file save was successful, otherwise an appropriate error code.

DzError : doSaveWithOptions( DzAssetIOFilter filter, DzFileIOSettings options, Boolean saveOnly=false, String filename=“”, String startingDir=“”, String category=“” )

Save the scene contents to a file with the given asset filter. Prompts the user for a file to save to.

Parameter(s):

filter - The filter to use.
options - The options to use.
saveOnly - Whether to only save the file, or to also create an associated icon and assign metadata.
filename - The full name of the file to save to.
startingDir - The path of the directory to start the save dialog in.
category - The category to assign the saved file to.

Return Value:

DZ_NO_ERROR if the file save was successful, otherwise an appropriate error code.

DzError : doSceneSaveAs()

Save the scene contents to a file. Prompts the user for a file to save to.

Return Value:

DZ_NO_ERROR if the file save was successful, otherwise an appropriate error code.

DzAuthor : getCurrentAssetContributor()

Return Value:

If isReadingOrWriting() is false, an invalid DzAuthor. If isReading() is true, the contributor for the file being read. If isWriting() is true, the contributor for the file being written.

See Also:

DzAuthor::isValid()
getFileInfo()

Since:

4.15.0.16

String : getCurrentAssetId()

Return Value:

If isReadingOrWriting() is false, an empty string. If isReading() is true, the asset identifier for the file being read. If isWriting() is true, the asset identifier for the file being written.

See Also:

getFileInfo()

Since:

4.15.0.16

DzVersion : getCurrentAssetRevision()

Return Value:

If isReadingOrWriting() is false, an invalid DzVersion. If isReading() is true, the revision for the file being read. If isWriting() is true, the revision for the file being written.

See Also:

DzVersion::isValid()
getFileInfo()

Since:

4.15.0.16

String : getCurrentAssetType()

Return Value:

If isReadingOrWriting() is false, an empty string. If isReading() is true, the asset type for the file being read. If isWriting() is true, the asset type for the file being written.

See Also:

getFileInfo()

Since:

4.15.0.16

Object : getCurrentFileInfo()

Return Value:

If isReadingOrWriting() is false, an empty object. If isReading() is true, an object containing “file_version” and “asset_info” for the file being read. If isWriting() is true, an object containing “file_version” and “asset_info” for the file being written.

Since:

4.15.0.16

String : getCurrentFilename()

Return Value:

The full name of the file that is currently being read from or written to (if any), otherwise an empty string.

Since:

4.15.0.16

DzVersion : getCurrentFileVersion()

Return Value:

If isReadingOrWriting() is false, an invalid DzVersion. If isReading() is true, the “file_version” for the file being read. If isWriting() is true, the “file_version” for the file being written.

See Also:

DzVersion::isValid()
getFileInfo()

Since:

4.15.0.16

String : getDefaultDSONAssetCachePath()

Return Value:

The default path for the DSON assets cache.

String : getDSONAssetCachePath()

Return Value:

The path that the DSON assets cache resides in.

See Also:

getDefaultDSONAssetCachePath()
setDSONAssetCachePath()

DzAuthor : getFileAssetContributor( String filename )

Parameter(s):

filename - The full name of the file to retrieve the information from.

Return Value:

The “asset_info” contributor embedded in an asset file (if any), otherwise an invalid DzAuthor.

See Also:

DzAuthor::isValid()
getFileInfo()

Since:

4.15.0.16

String : getFileAssetType( String filename )

Parameter(s):

filename - The full name of the file to retrieve the information from.

Return Value:

The “asset_info” type embedded in an asset file (if any), otherwise an empty string.

See Also:

getFileInfo()

Since:

4.15.0.16

Object : getFileInfo( String filename )

Parameter(s):

filename - The full name of the file to retrieve the information from.

Return Value:

An object containing the “file_version” and “asset_info” embedded in the specified asset file (if any), otherwise an empty object. The “asset_info” only contains “type” and “contributor” values - it does not include the “id”, “revision”, or “modified” values.

Since:

4.15.0.16

DzVersion : getFileVersion( String filename )

Parameter(s):

filename - The full name of the file to retrieve the information from.

Return Value:

The “file_version” embedded in an asset file (if any), otherwise an invalid DzVersion.

See Also:

DzVersion::isValid()
getFileInfo()

Since:

4.15.0.16

String : getLoadPath()

Return Value:

The path of the last directory that files were loaded from.

String : getSavePath()

Return Value:

The path of the last directory that files were saved to.

DzError : loadFromUri( DzUri fileUri, DzOpenMethod method=DefaultMethod, DzFileLoadFilter filter=null )

Loads an asset from URI.

Parameter(s):

fileUri - The URI of the file to load.
method - The method to use for loading.
filter - The filter to use.

Return Value:

DZ_NO_ERROR if the file load was successful, otherwise an appropriate error code.

See Also:

doLoad()

void : setDSONAssetCachePath( String cacheFullPath )

Sets the path for the DSON asset cache.

Parameter(s):

cacheFullPath - The path to set.

See Also:

getDSONAssetCachePath()

Signals

void : assetImported()

Signature:“assetImported()”

Emitted when an asset has been loaded.

void : assetImportStarting()

Signature:“assetImportStarting()”

Emitted when an asset load is starting.

void : assetLoadError( String filename )

Signature:“assetLoadError(const QString&)”

Emitted when an asset load error occures.

Parameter(s):

filename - The relative path of the asset.

Since:

4.15.0.16

void : assetLoadFinished( String filename )

Signature:“assetLoadFinished(const QString&)”

Emitted when an asset load is finished.

Parameter(s):

filename - The relative path of the asset.

Since:

4.15.0.16

void : assetLoadStarted( String filename )

Signature:“assetLoadStarted(const QString&)”

Emitted when an asset load has started.

Parameter(s):

filename - The relative path of the asset.

Since:

4.15.0.16

void : assetSaved()

Signature:“assetSaved()”

Emitted when an asset has been saved.

void : assetSaveError( String filename )

Signature:“assetSaveError(const QString&)”

Emitted when an asset save error occurs.

Parameter(s):

filename - The path of the asset.

Since:

4.15.0.16

void : assetSaveFinished( String filename )

Signature:“assetSaveFinished(const QString&)”

Emitted when an asset save is finished.

Parameter(s):

filename - The path of the asset.

Since:

4.15.0.16

void : assetSaveStarted( String filename )

Signature:“assetSaveStarted(const QString&)”

Emitted when an asset save has started.

Parameter(s):

filename - The path of the asset.

Since:

4.15.0.16

DzAssetMgr

2022-06-03T06:43:30+00:00

DzAssetMgr

Manager responsible for database records associated with “content.”.

More...

Inherits :

QObject
- DzBase

Enumerations

DAZ Script
CompatibilityBaseType	{ NoCompatibility, CompatibilityBase, CompatibilityFilter, CompatibilityBaseAndFilter }
MetadataType	{ NoData, UserData, VendorData, UserAndVendorData }
SearchOptions	{ None, WholeWord, RegExp, NativeScenes, NativeScripts, PoserFigures, PoserPoses, PoserProps, PoserHair, PoserFaces, PoserLights, PoserCameras, PoserHands, PoserMaterials, PoserScenes, ImportFiles, AllNativeFiles, NoNativeFilesMask, AllPoserFiles, NoPoserFilesMask, AllFiles, DefaultOptions }
StopModeCMS	{ SM_Smart, SM_Fast, SM_Immediate }

Static Methods

DAZ Script
Array	captureSceneAssetPathsList ( DzNode node, Object options=null )
Array	captureSceneAssetPathsList ( Object options=null )
String	escapeSearchTerm ( String searchTerm )
String	fileKeyForFilename ( String relativePath )
String	findCommonBaseCategoryPath ( Array categoryPaths, Boolean flatten=false )
String	getAssetUriForNode ( DzNode node )
String	getCategoriesID ()
String	getCompatibilityBasePathForNode ( DzNode node )
String	getCompatibilityBasesID ()
Number	getDAZ3DStoreID ()
String	getImportDirID ()
String	getPoserDirID ()
Array	getPoserVirtualDirID ()
String	getProductName ( String name, Array choices=[], Boolean allowEmpty=false )
Object	getProductsForFiles ( Array filenames )
String	getProductsID ()
String	getRealPathCasing ( String path, String search )
String	getRelativeProductMetafilePath ( String store, String token, String title, String extension=“dsx” )
Array	getSpecialPoserFolders ()
String	getStudioDirID ()
Array	getStudioExcludes ()
Array	getStudioVirtualDirID ()
String	normalizePath ( String type, Boolean relative=true )
DzError	saveUserDBData ( String dirPath, String filePrefix )
Boolean	setCompatibilityBaseID ( String uri, Number id, Boolean markAsVendor )
Boolean	setCompatibilityBasePath ( String uri, String compatibilityBasePath, Boolean markAsVendor, Boolean create=false )
void	setFileMetadata ( String filepath, String contentType, String compatibleWith, String category, DzNode assetNode=null, String compatibilityBase=“” )

Methods

DAZ Script
Object	buildMinimumProductSetForFiles ( Array filenames, Array products )
Object	buildMinimumProductSetForFiles ( Array filenames )
Boolean	canStartAndStopCMS ()
void	checkforNewMetadataScripts ()
void	clearAllGroupIDs ( Boolean notify=true )
void	clearDBMetaFileQueue ()
void	createCategoryPaths ( String paths, String settingsName=“” )
Number	createCompatibilityBase ( String base )
DzProductAssetContainer	createProduct ( String name, String storeID=“”, String token=“” )
DzProductAssetContainer	createProductFromAssets ( Array assets, String name=“” )
DzProductAssetContainer	createProductFromContainer ( DzAbstractAssetContainer container, String name=“” )
Boolean	createStore ( String storeID, String token, String url )
DzAbstractAssetContainer	createSubContainer ( DzAbstractAssetContainer parentContainer, String name=“”, String settingsName=“” )
Number	createType ( String type, Boolean defaultOpen )
void	emitCategoryChanged ( Array idPath )
String	findAssetPathFromShortFilename ( String fileName )
Array	findAssetsForFile ( String relativePath, Boolean userFacing, Boolean installed )
Number	findAudienceID ( String audience )
Number	findCategoryID ( String categoryPath, Boolean isVendor, Boolean create=false )
Number	findCompatibilityBaseID ( String base, Boolean create=true )
DzProductAssetContainer	findProductByGuid ( String guid )
DzProductAssetContainer	findProductByStoreToken ( String storeID, String token )
Array	findProductsByName ( String name )
Array	findProductsForFile ( String relativePath )
Number	findTypeID ( String type, Boolean create=false, Boolean defaultOpen=false )
String	getAudience ( Number id )
Array	getAudiences ()
DzCategoryAssetContainer	getCategories ()
Array	getCategoryData ( Boolean includeHeader=true, MetadataTypes dataType=UserAndVendorData )
String	getCategoryPath ( Number id )
String	getCMSBasePath ( Boolean create=false )
Object	getCMSOptions ()
Number	getCMSPort ()
String	getCompatibilityBase ( Number id )
Array	getCompatibilityBaseData ( Boolean includeHeader=true, CompatibilityBaseTypes baseType=CompatibilityBaseAndFilter, MetadataTypes dataType=UserAndVendorData )
DzCompatibilityBaseAssetContainer	getCompatibilityBases ( Boolean includeFilters=true )
String	getContainerName ( String title, String placeHolder=“”, String settingsName=“” )
DzTopLevelAssetContainer	getContentDirs ()
String	getDatabaseDsn ()
String	getDatabaseFilePath ()
Array	getDBMetaFileQueue ()
Array	getDefaultCategoryPaths ( String prefix=“”, Boolean append=false )
String	getDefaultCMSBasePath ()
Number	getDefaultCMSPort ()
String	getFirstCategory ( String assetPath, String preferredCategory, Boolean installed=true )
Boolean	getGroupNewProductsAsNew ()
DzTopLevelAssetContainer	getImportDirs ()
Number	getMaxFileSearchResultSize ()
Number	getNumMaxItemsPerPage ()
DzTopLevelAssetContainer	getPoserDirs ()
DzTopLevelAssetContainer	getProducts ()
Array	getRelativePaths ( String absolutePath, Boolean useImportFolders )
Array	getRootCategoryStrings ()
Boolean	getShowHiddenVendorCategorization ()
Array	getStoresIDs ()
String	getStoreToken ( String storeID )
String	getStoreUrl ( String storeID )
String	getType ( Number id )
String	getTypeForContentFile ( String path )
String	getTypeForNode ( DzNode node )
Array	getTypes ()
String	getUniqueChildCategoryName ( String categoryPath, String name )
Boolean	haveDatabase ()
Array	importMetadataFiles ( Array absoluteProductPaths, Boolean runSilent=false, Boolean markAsVendor=false )
Object	installMissingAssets ( Array filenames, Boolean noPrompt=false, String productMsg=“”, String unknownMsg=“” )
Boolean	isClothingType ( String type )
Boolean	isConnectedToCMS ()
Boolean	isFigureType ( String type )
Boolean	isFollowingType ( String type )
Boolean	isHairType ( String type )
Boolean	isNeedsBaseFigureType ( String type )
Boolean	isPresetForFigureType ( String type )
Boolean	isPresetType ( String type )
Boolean	isPropType ( String type )
Boolean	isReplaceableType ( String type )
Boolean	isResettingDatabase ()
Boolean	isSynchronizing ()
void	markCategoriesChanged ()
void	markProductsChanged ()
Array	processDBMetaFile ( String productRelativePath, Boolean runSilent=false, Boolean markAsVendor=false, Boolean groupAsNew=true )
Array	processDBMetaFileNoEmit ( String productRelativePath, Boolean runSilent=false, Boolean markAsVendor=false, Boolean groupAsNew=true )
void	processDBMetaFileQueue ()
void	queueDBMetaFile ( String productRelativePath )
void	refreshCategoryRoots ()
void	refreshStores ()
void	refreshTypes ()
void	reimportDBMetaFiles ()
void	removeOrphanedAssetReferences ( Array list )
Boolean	removeStore ( String storeID )
void	resetDatabase ()
void	scanFiles ( SearchOptions options, Boolean assignToGroup, Boolean addToCategory, Boolean onlyNewToCategory )
DzSearchContainer	searchFiles ( String filename, SearchOptions options )
DzSearchContainer	searchForAssetAddOns ( DzAsset asset, String filterText, Array categories, SortType sorting )
DzSearchContainer	searchForAssets ( String filterText, Array categories, Array compatibilityBases, Array contentTypes, SortType sorting )
DzSearchContainer	searchForAssetsByKeywords ( String keywords, SearchOptions options, SortType sorting )
DzSearchContainer	searchForAssetsInCategory ( String categoryPath, Boolean userFacing=true, Boolean installed=true )
DzSearchContainer	searchForAssetTargets ( DzAsset asset, String filterText, Array categories, SortType sorting )
DzSearchContainer	searchForProductAssets ( DzProductAssetContainer product, String filterText, Array categories, Array compatibilityBases, Array contentTypes, SortType sorting )
DzProductHolderContainer	searchForProducts ( String filterText, Array categories, Array compatibilityBases, Array contentTypes, ProductInstallStates installStateFlags, SortType sorting )
Array	selectCategoryPaths ( Boolean multiSelect=false, Array startWith=[], String title=“”, String settingsName=“” )
Array	selectCompatibilityBasePaths ( Boolean showFilters=true, Boolean multiSelect=false, Array startWith=[], String title=“”, String settingsName=“” )
void	setCMSOptions ( String clusterDirectory, Number port )
void	setGroupNewProductsAsNew ( Boolean onOff )
void	setMaxFileSearchResultSize ( Number maxNum )
void	setMaxItemsPerPage ( Number maxNum )
void	setProductGroupIDs ( Array guids, Number groupId, Boolean groupProduct=true, Boolean groupFiles=true )
void	setShowAssetToolTip ( Boolean onOff )
void	setShowExtensions ( Boolean onOff )
void	setShowHiddenVendorCategorization ( Boolean shown )
void	setShowLargeIcons ( Boolean onOff )
Boolean	showAssetToolTip ()
Boolean	showDatabaseEditor ( DzAbstractAssetContainer assetContainer )
Boolean	showExtensions ()
Boolean	showLargeIcons ()
void	showMoreProductInfo ( DzProductAssetContainer product )
void	startCMS ()
void	stopAllSearches ()
void	stopCMS ( StopModeCMS mode, Boolean wait, Number timeout=0 )
void	stopFileScan ()
void	stopFileSearch ()
void	stopSearchForAssetAddOns ()
void	stopSearchForAssets ()
void	stopSearchForAssetTargets ()
void	stopSearchForProducts ()
void	updateCategoryContainers ()
void	updateContentContainers ()
void	updateFolderBasedContainers ()
void	updateImportContainers ()
void	updatePoserContainers ()
void	updateProductContainers ()
Boolean	vacuumDatabase ()

Signals

void	basePathsChanged ()
void	categoryUpdate ( Array idPath )
void	cmsDSNChanged ()
void	cmsStarted ()
void	cmsStopped ()
void	compatibilityBaseListChanged ()
void	containerUpdate ( Array idPath )
void	groupNewProductsAsNewChanged ()
void	itemsPerPageChanged ( Number newPerPage )
void	maxFileSearchResultSizeChanged ( Number maxFileSearchResultSize )
void	productCreated ( String guid )
void	showAssetToolTipChanged ()
void	showExtensionsChanged ()
void	showHiddenVendorCategorizationChanged ()
void	showLargeIconsChanged ()
void	storeListChanged ()
void	typeListChanged ()
void	uiAboutToSearch ( QObject sender, String text, Array categories, Array compatibilityBases, Array contentTypes )

Detailed Description

Responsible for the management of database records associated with “content” (digital assets).

There is only one instance of this manager in an application. This instance is created and owned by DzApp. Request the instance via DzApp::getAssetMgr().

See Also:

Enumerations

: CompatibilityBaseType

TODO: Add description.

NoCompatibility - A value that represents “None” in the context of Compatibility Bases/Filters.
CompatibilityBase - A value that represents the base concept of an object.
CompatibilityFilter - A value that represents a specific configuration on the base concept of an object.
CompatibilityBaseAndFilter - A value that represents the base concept of an object, as well as a specific configuration on the base concept of an object.

—–

: MetadataType

TODO: Add description.

NoData - Metadata that is not created, owned or maintained by the vendor (originating source) or the user - i.e. none.
UserData - Metadata that is created, owned and maintained by the user.
VendorData - Metadata that is created, owned and maintained by the vendor (originating source).
UserAndVendorData - Metadata that is created, owned and maintained by the vendor (originating source) and/or the user.

—–

: SearchOptions

Search options used to search assets with the Asset Manager.

None - No options
WholeWord - A whole word search. Only works with file system based searches.
RegExp - A Regular Expression search. Only works with file system based searches.
NativeScenes - Include native scene files (*.duf, *.dsf, *.daz) in the search.
NativeScripts - Include native script files (*.ds, *.dsa, *.dsb, *.dse) in the search.
PoserFigures - Include Poser Character files (*.cr2, *.crz) in the search.
PoserPoses - Include Poser Pose files (*.pz2, *.p2z) in the search.
PoserProps - Include Poser Prop files (*.pp2, *.ppz) in the search.
PoserHair - Include Poser Hair files (*.hr2, *.hrz) in the search.
PoserFaces - Include Poser Face (Expression) files (*.fc2,*.fcz) in the search.
PoserLights - Include Poser Light files (*.lt2, *.ltz) in the search.
PoserCameras - Include Poser Camera files (*.cm2, *.cmz) in the search.
PoserHands - Include Poser Hand files (*.hd2, *.hdz) in the search.
PoserMaterials - Include Poser Material Collection files (*.mc6, *.mcz) in the search.
PoserScenes - Include Poser Scene files (*.pz3, *.pzz) in the search.
ImportFiles - Include general import files in the search.
AllNativeFiles - Include all native files (*.duf, *.dsf, *.daz, *.ds, *.dsa, *.dsb, *.dse) in the search.
NoNativeFilesMask - Mask for no native files in the search.
AllPoserFiles - Include all Poser files in the search.
NoPoserFilesMask - Mask for no Poser files in the search.
AllFiles - Search through all files.
DefaultOptions - Same as AllFiles.

—–

: StopModeCMS

Modes for stopping the Content Management Service (CMS).

Since:

4.11.0.32

SM_Smart - Waits for all active clients to disconnect and any online backup to finish. If the service is in hot standby, recovery and streaming replication will be terminated once all clients have disconnected.
SM_Fast - Does not wait for clients to disconnect and terminates an online backup in progress. All active transactions are rolled back and clients are forcibly disconnected, then the service is shut down.
SM_Immediate - Aborts all service processes immediately, without a clean shutdown.

Static Methods

Array : captureSceneAssetPathsList( DzNode node, Object options=null )

Parameter(s):

node - A node to look for scene assets on.
options - Options to control what and how assets are gathered. Currently only supports a bool option named “selected”, which the value of is used to indicate whether to only consider selected nodes or all nodes (default).

Return Value:

A list of paths to scene assets for the given node (if any).

Since:

4.20.0.11

Array : captureSceneAssetPathsList( Object options=null )

Parameter(s):

options - Options to control what and how assets are gathered. Currently only supports a bool option named “selected”, which the value of is used to indicate whether to only consider selected nodes or all nodes (default).

Return Value:

A list of paths to scene assets (if any).

Since:

4.20.0.11

String : escapeSearchTerm( String searchTerm )

Parameter(s):

searchTerm - The search term to be escaped.

Return Value:

An escaped version of searchTerm

String : fileKeyForFilename( String relativePath )

Parameter(s):

relativePath - The relative path of the file to convert to a key.

Return Value:

The normalized, lowercase, leading '/' removed, version of relativePath that should be used to look up relativePath in the database.

Since:

4.16.1.32

String : findCommonBaseCategoryPath( Array categoryPaths, Boolean flatten=false )

Parameter(s):

categoryPaths - The list of category paths to find a common path in. This can be a list of strings, or a list of lists of strings.
flatten - If true, the categories are processed as if they are a single list. If false (default), the deepest path common to all lists will be chosen. In either case, non-default categorization is preferred over default categorization.

Return Value:

A string representing the portion of categoryPaths that is common.

Since:

4.9.2.68

String : getAssetUriForNode( DzNode node )

Parameter(s):

node - The node to get the asset URI for.

Return Value:

The asset URI for node, or an empty string if node is null.

String : getCategoriesID()

Return Value:

An identifier for the top level categories container.

String : getCompatibilityBasePathForNode( DzNode node )

Parameter(s):

node - The node to get compatibility base for.

Return Value:

A slash (“/”) delimited string version of the node's compatibility base path (if any), otherwise an empty string.

String : getCompatibilityBasesID()

Return Value:

An identifier for the top level compatibility bases container.

Since:

4.11.0.93

Number : getDAZ3DStoreID()

Return Value:

The 64-bit integer used to represent the store id for the Daz 3D store.

Since:

4.20.0.11

String : getImportDirID()

Return Value:

An identifier for the top level import formats container.

String : getPoserDirID()

Return Value:

An identifier for the top level Poser formats container.

Array : getPoserVirtualDirID()

Return Value:

The identifier for the virtual folder container within the top level Poser formats container.

Since:

4.9.2.68

String : getProductName( String name, Array choices=[], Boolean allowEmpty=false )

Prompts the user for a valid product name.

Parameter(s):

name - The product name (if any) to use if a product with the same name does not already exist in the database. An empty string, or a non-unique name, will cause the user to be prompted for a unique name.
choices - A list of pre-defined choices (if any) to provide the user.
allowEmpty - If true, an empty value is considered acceptable.

Return Value:

A string that represents a valid product name (if allowEmpty is false - default), otherwise an empty string.

Since:

4.12.1.100

Object : getProductsForFiles( Array filenames )

Parameter(s):

filenames - A list of filenames to find products for.

Return Value:

An object with the following members (if no errors):
products_parent : The parent containter for the list of products.
products : An array of products found.
unknown : An array of files that no products were found for.

See Also:

Since:

4.20.0.11

String : getProductsID()

Return Value:

An identifier for the top level products container.

String : getRealPathCasing( String path, String search )

Parameter(s):

path - The path to the file/folder that real, on disk, casing is desired for.
search - A file/folder in the path to get the on disk casing for.

Return Value:

A string path/search combination or empty string if search is not in path.

String : getRelativeProductMetafilePath( String store, String token, String title, String extension=“dsx” )

Parameter(s):

store - The store ID for the product.
token - The token for the product.
title - The title of the product.
extension - The extension of the meta file.

Return Value:

The relative metadata file path.

Since:

4.9.4.31

Array : getSpecialPoserFolders()

Return Value:

A list of the folder names that are considered special, and thus handled in specific ways, in a Poser runtime.

String : getStudioDirID()

Return Value:

An identifier for the top level DAZ Studio formats container.

Array : getStudioExcludes()

Return Value:

A list of the folder names excluded when building the native user-facing folder structure.

Array : getStudioVirtualDirID()

Return Value:

The identifier for the virtual folder container within the top level DAZ Studio formats container.

Since:

4.9.2.68

String : normalizePath( String type, Boolean relative=true )

Parameter(s):

type - The path/type to be normalized.
relative - Whether or not this is a relative (or absolute) path.

Return Value:

A normalized version of type.

DzError : saveUserDBData( String dirPath, String filePrefix )

Saves user owned metadata to an XML file (or a series of XML files).

Parameter(s):

dirPath - The path to save user metadata files in.
filePrefix - The prefix for the filename sequence.

Return Value:

DZ_NO_ERROR on success, otherwise an error code.

Boolean : setCompatibilityBaseID( String uri, Number id, Boolean markAsVendor )

Sets the compatibility base for a URI.

Parameter(s):

uri - The asset URI to set the compatibility base for.
id - The 64-bit integer used to identify the compatibility base.
markAsVendor - If true, the compatibility base is marked as being owned by a vendor.

Return Value:

true if the compatibility base is set, otherwise false.

See Also:

getAssetUriForNode()
getCompatibilityBasePathForNode()
findCompatibilityBase()
createCompatibilityBase()
getCompatibilityBase()

Since:

4.11.0.183

Boolean : setCompatibilityBasePath( String uri, String compatibilityBasePath, Boolean markAsVendor, Boolean create=false )

Sets the compatibility base for a URI.

Parameter(s):

uri - The asset URI to set the compatibility base for.
compatibilityBasePath - The slash (“/”) delimited path of the compatibility base to set.
markAsVendor - If true, the compatibility base is marked as being owned by a vendor.
create - If true, creates the compatibility base if it does not already exist.

Return Value:

true if the compatibility base is set, otherwise false.

See Also:

getAssetUriForNode()
getCompatibilityBasePathForNode()

Since:

4.11.0.183

void : setFileMetadata( String filepath, String contentType, String compatibleWith, String category, DzNode assetNode=null, String compatibilityBase=“” )

Sets the metadata associated with a file.

Parameter(s):

filepath - The path of the file to set the metadata on.
contentType - The content type to set.
compatibleWith - The compatibility base the asset is an add-on for.
category - The category to put the asset in.
assetNode - The node to get the compatibility base from.
compatibilityBase - The compatibility base to set; for add-ons to target.

Since:

4.9.0.17

Methods

Object : buildMinimumProductSetForFiles( Array filenames, Array products )

Parameter(s):

filenames - The list of relative file paths to find the minimum product set for.
products - The list of products to limit the search for filenames to - can be expressed as GUID strings, DzProductAssetContainer instances, or DzScriptHandle instances that hold DzProductAssetContainer instances.

Return Value:

A map consisting of a list of GUIDs (“product_guids”) for the products that represent the minimum set to satisfy the list of filenames specified, and a map of product GUIDs and the files each product respectively provides (“product_found_files”).

Since:

4.16.1.33

Object : buildMinimumProductSetForFiles( Array filenames )

Parameter(s):

filenames - The list of relative file paths to find the minimum product set for.

Return Value:

A map consisting of a list of GUIDs (“product_guids”) for the products that represent the minimum set to satisfy the list of filenames specified, a map of product GUIDs and the files each product respectively provides (“product_found_files”), and a list of the files specified in filenames that could not be associated with a product (“unknown”).

Attention:

This function will consult the database to find a list of products for the list of filenames specified.

Since:

4.16.1.33

Boolean : canStartAndStopCMS()

Return Value:

true if the currently connected Content Management Service (CMS) is of the type that can be started and stopped, otherwise false.

void : checkforNewMetadataScripts()

Checks for new metadata scripts within the RunOnce directories.

void : clearAllGroupIDs( Boolean notify=true )

Removes all groups from all assets.

Parameter(s):

notify - If true, causes product and category containers to update.

void : clearDBMetaFileQueue()

Clears the metadata queue.

void : createCategoryPaths( String paths, String settingsName=“” )

Presents the user with a category path creation dialog.

Parameter(s):

paths - The category path (if any) to set - separate multiple paths with commas.
settingsName - The base name of the settings to store to/restore from. If set to an empty string (default), the default will be used.

Since:

4.15.0.16

Number : createCompatibilityBase( String base )

Creates a compatibility base.

Parameter(s):

base - The compatibility base to create.

Return Value:

An integer used to identify base.

DzProductAssetContainer : createProduct( String name, String storeID=“”, String token=“” )

Creates a new product.

Parameter(s):

name - The name for the product - used if a product with the storeID and token specified does not already exist in the database to name the product.
storeID - The identifier (e.g., “DAZ 3D”) of the store for the product. If the store does not exist in the database or this argument is an empty string (default), the “LOCAL USER” store will be used.
token - The token (i.e., SKU) used to identify the product in the storeID store.

Return Value:

The product named name, from store storeID, with the token token. If a product with the storeID and token already exists, a new product will not be created and the existing product will be returned instead.

See Also:

createStore()
getProductName()
DzScriptHandle

Since:

4.9.3.39

DzProductAssetContainer : createProductFromAssets( Array assets, String name=“” )

Creates a new product from a list of assets.

Parameter(s):

assets - The list of assets to create the product from.
name - The name for the product. If empty (default), the user will be prompted to provide a name.

See Also:

DzScriptHandle

Since:

4.9.3.41

DzProductAssetContainer : createProductFromContainer( DzAbstractAssetContainer container, String name=“” )

Creates a new product from container and its children.

Parameter(s):

container - The asset container to create the product from.
name - The name for the product. If empty (default), the user will be prompted to provide a name.

See Also:

DzScriptHandle

Since:

4.9.3.39

Boolean : createStore( String storeID, String token, String url )

Attempts to create a store in the database.

Parameter(s):

storeID - The identifier of the store (e.g., “DAZ 3D”) to create.
token - The value within url to be replaced by a product's identifier (e.g., SKU) within that store when the product's final URL is constructed.
url - The URL for the store.

Return Value:

true if the store is successfully created, otherwise false.

Attention:

The “DAZ 3D” and “LOCAL USER” storeIDs are reserved. Attempting to create a store with either ID will fail immediately and return a value of false.

See Also:

showMoreProductInfo()
Sample: Add Store Id

DzAbstractAssetContainer : createSubContainer( DzAbstractAssetContainer parentContainer, String name=“”, String settingsName=“” )

Creates a (folder/category/compatibility base) sub-container.

Parameter(s):

parentContainer - The container to create a sub-container on.
name - The name of the sub-container to create. If set to an empty string (default), the user will be prompted.
settingsName - The base name of the settings to store to/restore from. If set to an empty string (default), the default will be used.

See Also:

DzAbstractAssetContainer::canAddSubContainer()
DzFolderAssetContainer
DzCategoryAssetContainer
DzCompatibilityBaseAssetContainer

Since:

4.15.0.16

Number : createType( String type, Boolean defaultOpen )

Creates a content type.

Parameter(s):

type - The content type to create.
defaultOpen - If true, assets that the type is assigned to will be opened by default; the contents of the scene will be cleared prior to loading the asset. If false , assets that the type is assigned to will be merged by default; the asset will be added to the existing scene.

Return Value:

An integer used to identify type.

void : emitCategoryChanged( Array idPath )

Causes the category identified by idPath to update.

Parameter(s):

idPath - The id path of the category to update.

String : findAssetPathFromShortFilename( String fileName )

Parameter(s):

fileName - The short name of the file to find the asset path for.

Return Value:

If fileName can be found, the physical path of the asset on disk, otherwise an empty string.

Array : findAssetsForFile( String relativePath, Boolean userFacing, Boolean installed )

Parameter(s):

relativePath - The relative path of a file to find assets for.
userFacing - Whether or not the file is user-facing.
installed - Whether or not the file is installed.

Return Value:

A list of assets that relativePath refers to.

See Also:

DzScriptHandle

Since:

4.9.2.69

Number : findAudienceID( String audience )

Return Value:

The id used to identify audience.

Number : findCategoryID( String categoryPath, Boolean isVendor, Boolean create=false )

Parameter(s):

categoryPath - The full path of the category to find.
isVendor - If true, the category is marked as being owned by a vendor.
create - If true, the category is created if it cannot be found.

Return Value:

A 64-bit integer used to identify the category (if any), otherwise -1.

Since:

4.15.0.16

Number : findCompatibilityBaseID( String base, Boolean create=true )

Attempts to find a compatibility base, and potentially create it if it does not already exist.

Parameter(s):

base - The compatibility base to find (or create).
create - If true, the compatibility base is created if it cannot be found.

Return Value:

An integer used to identify base.

DzProductAssetContainer : findProductByGuid( String guid )

Parameter(s):

guid - The Globally Unique Identifier (GUID) of the product to find.

Return Value:

The product with the globally unique identifier guid, otherwise null.

See Also:

DzScriptHandle

Since:

4.9.2.69

DzProductAssetContainer : findProductByStoreToken( String storeID, String token )

Parameter(s):

storeID - The identifier of the store (e.g., “DAZ 3D”) for the product.
token - The token (i.e., SKU) used to identify the product in the storeID store.

Return Value:

The product from storeID store with the token token, otherwise null.

See Also:

DzScriptHandle

Since:

4.9.3.39

Array : findProductsByName( String name )

Parameter(s):

name - The name of the products to find.

Return Value:

A list of products (if any) that are named name.

See Also:

DzScriptHandle

Since:

4.9.3.39

Array : findProductsForFile( String relativePath )

Parameter(s):

relativePath - The relative path of a file to find products that contain it.

Return Value:

A list of products that contain relativePath in their respective list of assets.

See Also:

DzScriptHandle

Since:

4.8.1.73

Number : findTypeID( String type, Boolean create=false, Boolean defaultOpen=false )

Attempts to find the identifier used to identify a content type.

Parameter(s):

type - The content type to find.
create - If true, the content type is created if it cannot be found.
defaultOpen - If true, assets that the type is assigned to will be opened by default; the contents of the scene will be cleared prior to loading the asset. If false , assets that the type is assigned to will be merged by default; the asset will be added to the existing scene.

Return Value:

An integer used to identify type.

String : getAudience( Number id )

Parameter(s):

id - The unsigned 32-bit integer used to identify the audience.

Return Value:

The audience identified by id.

Array : getAudiences()

Return Value:

The list of available audiences.

DzCategoryAssetContainer : getCategories()

Return Value:

A top-level container with child containers that match the hierarchy of categories in the content database.

Array : getCategoryData( Boolean includeHeader=true, MetadataTypes dataType=UserAndVendorData )

Parameter(s):

includeHeader - If true (default), the first list in the return value will contain descriptors for the values in all subsequent lists.
dataType - The type of data to retrieve.

Return Value:

A two dimensional list of the raw data that defines categories.

Since:

4.15.0.16

String : getCategoryPath( Number id )

Parameter(s):

id - The 64-bit integer used to identify the category.

Return Value:

The full slash (“/”) delimited path of the category (if any), otherwise an empty string.

Since:

4.9.3.11

String : getCMSBasePath( Boolean create=false )

Parameter(s):

create - If true, creates any folders in the returned path that do not currently exist.

Return Value:

The base path for the Content Management Service (CMS).

See Also:

getDefaultCMSBasePath()

Since:

4.11.0.248

Object : getCMSOptions()

Return Value:

A JSON object consisting of options for the currently connected Content Management Service (CMS).

Number : getCMSPort()

Return Value:

The port for communicating with the Content Management Service (CMS).

See Also:

getDefaultCMSPort()

Since:

4.11.0.248

String : getCompatibilityBase( Number id )

Parameter(s):

id - The integer used to identify the compatibility base.

Return Value:

The compatibility base identified by id.

Array : getCompatibilityBaseData( Boolean includeHeader=true, CompatibilityBaseTypes baseType=CompatibilityBaseAndFilter, MetadataTypes dataType=UserAndVendorData )

Parameter(s):

includeHeader - If true (default), the first list in the return value will contain descriptors for the values in all subsequent lists.
baseType - The type of compatibility bases to retrieve.
dataType - The type of data to retrieve.

Return Value:

A two dimensional list of the raw data that defines compatibility bases.

Since:

4.15.0.16

DzCompatibilityBaseAssetContainer : getCompatibilityBases( Boolean includeFilters=true )

Parameter(s):

includeFilters - If true (default), child containers for filters (filter) will be included.

Return Value:

A top-level container (if the content database is active) with child containers that match the hierarchy of compatibility bases in the content database, otherwise null.

Since:

4.11.0.94

String : getContainerName( String title, String placeHolder=“”, String settingsName=“” )

Presents the user with a (folder/category/compatibility base) sub-container creation dialog.

Parameter(s):

title - The container to create a sub-container for- only supports DzFolderAssetContainer, DzCompatibilityBaseAssetContainer, and DzCategoryAssetContainer.
placeHolder - The text to display as a hint to the user. If set to an empty string (default), the default will be used.
settingsName - The base name of the settings to store to/restore from. If set to an empty string (default), the default will be used.

Since:

4.15.0.16

DzTopLevelAssetContainer : getContentDirs()

Return Value:

A top-level container with all of the mapped native content directories.

String : getDatabaseDsn()

Return Value:

The Data Source Name (DSN) -i.e. “connection string”- for the PostgreSQL server if the server version is valid, otherwise an empty string.

Since:

4.9.0.17

String : getDatabaseFilePath()

Return Value:

The path on disk where database files are located; for backup purposes.

Array : getDBMetaFileQueue()

Return Value:

A list of metadata files queued for processing.

Array : getDefaultCategoryPaths( String prefix=“”, Boolean append=false )

Parameter(s):

prefix - If non-empty, this value is used to replace the leading root “Default” category in the values returned by getRootCategoryStrings(), otherwise the return value will be the same as calling getRootCategoryStrings() directly.
append - If true and root is not an empty string, the modified values are appended to the end of the getRootCategoryStrings() list - if root is an empty string, this parameter has no affect. If false (default) and is a non-empty string, only the modified values are returned.

Return Value:

A list of 'default' category paths.

See Also:

getRootCategoryStrings()

Since:

4.15.0.15

String : getDefaultCMSBasePath()

Return Value:

The default base path for the Content Management Service (CMS).

See Also:

getCMSBasePath()

Since:

4.11.0.248

Number : getDefaultCMSPort()

Return Value:

The default port for communicating with the Content Management Service (CMS).

See Also:

getCMSPort()

Since:

4.11.0.248

String : getFirstCategory( String assetPath, String preferredCategory, Boolean installed=true )

Parameter(s):

assetPath - The path of the asset to find the first category for.
preferredCategory - The path of the category preferred if it exists and the asset at assetPath is assigned to it.
installed - If true, assetPath is only tested against files that are installed. If false , assetPath is only tested against files that are not installed. (since 4.11.0.88)

Return Value:

The full path of the first category that the file at assetPath is assigned to.

Boolean : getGroupNewProductsAsNew()

Return Value:

true if new products should be assigned to the “New” group, otherwise false.

See Also:

setGroupNewProductsAsNew()

Since:

4.9.0.23

DzTopLevelAssetContainer : getImportDirs()

Return Value:

A top-level container with all of the mapped import content directories.

Number : getMaxFileSearchResultSize()

Return Value:

The maximum number of items returned by a file search.

Since:

4.9.0.15

Number : getNumMaxItemsPerPage()

Return Value:

The maximum number of items to show per page.

DzTopLevelAssetContainer : getPoserDirs()

Return Value:

A top-level container with all of the mapped Poser directories.

DzTopLevelAssetContainer : getProducts()

Return Value:

A top-level container with child containers for intermediate alpha-numeric organization of products by name. Each intermediate container then has its respective children for the products in the content database.

See Also:

Sample: Metadata : List Products

Array : getRelativePaths( String absolutePath, Boolean useImportFolders )

Attempts to shorten absolutePath to a list of paths that are relative to one of the mapped content directories.

Parameter(s):

absolutePath - The path to make relative.
useImportFolders - If true, the mapped import folders will also be searched.

Return Value:

A list of relative paths to the file if one can be made, otherwise and empty list

See Also:

DzContentMgr::getRelativePaths()

Array : getRootCategoryStrings()

Return Value:

A list of root category paths.

Boolean : getShowHiddenVendorCategorization()

Return Value:

true if hidden vendor categorizations are shown, otherwise false.

Since:

4.9.3.4

Array : getStoresIDs()

Return Value:

A list of store identifiers.

See Also:

Sample: Store Info

String : getStoreToken( String storeID )

Parameter(s):

storeID - The identifier of the store (e.g., “DAZ 3D”) to get the token for.

Return Value:

The token used in the URL for the storeID store, which is to be replaced by a product's identifier (e.g., SKU) within that store when the product's final URL is constructed.

See Also:

Sample: Store Info

String : getStoreUrl( String storeID )

Parameter(s):

storeId - The identifier of the store (e.g., “DAZ 3D”) to get the URL for.

Return Value:

The URL for the storeID store.

See Also:

Sample: Store Info

String : getType( Number id )

Parameter(s):

id - The integer used to identify the content type.

Return Value:

The content type identified by id.

String : getTypeForContentFile( String path )

Performs a database lookup on a user-facing content file to get its content type.

Parameter(s):

path - The path of the file to get the content type for.

Return Value:

The content type of the file if the file is in the content database and is user-facing, otherwise an empty string.

String : getTypeForNode( DzNode node )

Checks the given node for content type in its presentation (if any), falls back to a source file data item and performs a content database lookup on the path it specifies (if any), and finally falls back to the content file path of the node (if any) to find its content type.

Parameter(s):

node - The node in the scene to get the content type of.

Return Value:

The content type for the node (if any), otherwise an empty string.

Array : getTypes()

Return Value:

A list of hierarchical, slash (“/”) delimited, content types

String : getUniqueChildCategoryName( String categoryPath, String name )

Parameter(s):

categoryPath - The full path of the parent category to check.
name - The name to check for uniqueness.

Return Value:

A unique name for the child category. If name is unique, the same value us returned. If categoryPath is invalid, an empty string is returned. If name is not unique, a dialog is

Since:

4.15.0.16

Boolean : haveDatabase()

Return Value:

true if the PostgreSQL server version is valid and the DSN is non-empty, otherwise false.

Since:

4.9.0.17

See Also:

getDatabaseDsn()

Array : importMetadataFiles( Array absoluteProductPaths, Boolean runSilent=false, Boolean markAsVendor=false )

Causes metadata files at absoluteProductPaths to be imported.

Parameter(s):

absoluteProductPaths - The list of absolute paths to import product metadata from.
runSilent - If true, the progress dialog will not be shown.
markAsVendor - If true, the data is considered vendor owned.

Object : installMissingAssets( Array filenames, Boolean noPrompt=false, String productMsg=“”, String unknownMsg=“” )

Installs the assets specified if a product they belong to can be found.

Parameter(s):

filenames - The list of relative file names to install. It is the developer's responsibility to verify that the file names passed in are not already in a mapped content directory.
noPrompt - If true, installation of any product(s) found begins immediately without prompting the user; this does not prevent progress from being reported. The default is false , which prompts the user and waits for a response.
productMsg - The message to display above the installable products list. If this is an empty string (default), a default string will be used.
unknownMsg - The message to display above the unknown files list. If this is an empty string (default), a default string will be used.

Return Value:

A JSON object consisting of a list of any products that were found to contain the missing files, a list of the files that were found per product (since 4.16.1.32), a list of the files that were not found in any product, and a list of the products that were selected for installation.

Attention:

The “-logMissingProduct” option can be used on the command line to log “Missing Products” encountered during the asset loading process - since 4.15.0.16.

See Also:

DzContentMgr::getAbsolutePath()

Since:

4.11.0.116

Boolean : isClothingType( String type )

Parameter(s):

type - The content type to test.

Return Value:

true if type is of the base type of Clothing, otherwise false.

See Also:

DzContentReplaceMgr

Boolean : isConnectedToCMS()

Return Value:

true if the Content Management Service (CMS) is currently connected, otherwise false.

Boolean : isFigureType( String type )

Parameter(s):

type - The content type to test.

Return Value:

true if type is of the base type of Figure, otherwise false.

See Also:

DzContentReplaceMgr

Boolean : isFollowingType( String type )

Parameter(s):

type - The content type to test.

Return Value:

true if type is of a following type, otherwise false.

See Also:

DzContentReplaceMgr

Boolean : isHairType( String type )

Parameter(s):

type - The content type to test.

Return Value:

true if type is of the base type of Hair, otherwise false.

See Also:

DzContentReplaceMgr

Boolean : isNeedsBaseFigureType( String type )

Parameter(s):

type - The content type to test.

Return Value:

true if type is of a type that needs a base figure, otherwise false.

See Also:

DzContentReplaceMgr

Boolean : isPresetForFigureType( String type )

Parameter(s):

type - The content type to test.

Return Value:

true if type is a Preset for a Figure, otherwise false.

See Also:

DzContentReplaceMgr

Boolean : isPresetType( String type )

Parameter(s):

type - The content type to test.

Return Value:

true if type is of the base type of Preset, otherwise false.

See Also:

DzContentReplaceMgr

Boolean : isPropType( String type )

Parameter(s):

type - The content type to test.

Return Value:

true if type is of the base type of Prop, otherwise false.

See Also:

DzContentReplaceMgr

Boolean : isReplaceableType( String type )

Parameter(s):

type - The content type to test.

Return Value:

true if type is of a replaceable type, otherwise false.

See Also:

DzContentReplaceMgr

Boolean : isResettingDatabase()

Return Value:

true if the connected PostgreSQL database is currently being reset, otherwise false.

Since:

4.9.0.17

Boolean : isSynchronizing()

Return Value:

true if the database is currently synchronizing, otherwise false.

4.9.3.71

void : markCategoriesChanged()

Signals that categories need to be updated.

void : markProductsChanged()

Signals that products need to be updated.

Array : processDBMetaFile( String productRelativePath, Boolean runSilent=false, Boolean markAsVendor=false, Boolean groupAsNew=true )

Causes the metadata file at productRelativePath to be processed and category containers to update.

Parameter(s):

productRelativePath - The relative product path to import metadata from.
runSilent - If true, the progress dialog will not be shown.
markAsVendor - If true, the data is considered vendor owned.
groupAsNew - If true, the product/assets are grouped as “New”.

Array : processDBMetaFileNoEmit( String productRelativePath, Boolean runSilent=false, Boolean markAsVendor=false, Boolean groupAsNew=true )

Causes the metadata file at productRelativePath to be processed, without causing category containers to update.

Parameter(s):

productRelativePath - The relative product path to import metadata from.
runSilent - If true, the progress dialog will not be shown.
markAsVendor - If true, the data is considered vendor owned.
groupAsNew - If true, the assets are grouped as “New”.

void : processDBMetaFileQueue()

If metadata files are queued, causes the metadata import dialog to be displayed and allows the user to select which products to process metadata for, then starts the import process on the selected products.

void : queueDBMetaFile( String productRelativePath )

Adds the file at productRelativePath to the metadata queue.

void : refreshCategoryRoots()

Causes the internal list of root categories to be rebuilt.

void : refreshStores()

Causes the internal list of stores to be rebuilt.

void : refreshTypes()

Causes the internal list of content types to be rebuilt

void : reimportDBMetaFiles()

Causes all *.dsx metadata files in the “./Runtime/Support” folder of each mapped native and Poser content directory to be queued, and then imported.

void : removeOrphanedAssetReferences( Array list )

Removes assets in list that have been orphaned (no longer exist) from the database.

Parameter(s):

list - The list of DzAsset to check whether the files still exist.

Since:

4.9.0.17

Boolean : removeStore( String storeID )

Attempts to remove a store from the database.

Parameter(s):

storeID - The identifier of the store (e.g., “DAZ 3D”) to remove.

Return Value:

true if the store is successfully removed, otherwise false.

Attention:

The “DAZ 3D” and “LOCAL USER” storeIDs are reserved. Attempting to remove a store with either ID will fail immediately and return a value of false.

See Also:

Sample: Remove Store Id

Since:

4.9.1.24

void : resetDatabase()

Triggers the connected PostgreSQL server to reset (delete) the current database and re-establish the default content types, compatibility bases, and categories.

Attention:

Stops all running searches and logs the current user out, if needed.

Since:

4.9.0.17

void : scanFiles( SearchOptions options, Boolean assignToGroup, Boolean addToCategory, Boolean onlyNewToCategory )

Performs a user-facing file scan, ultimately mapping any directories found to contain compatible content.

Parameter(s):

options - A bitwise OR of the options to use for filtering the file scan.
assignToGroup - If true, groups any found files as “New”.
addToCategory - If true, found files are assigned to the “Scan Results” category.
onlyNewToCategory - If true, only “new” files are assigned to the “Scan Results” category.

DzSearchContainer : searchFiles( String filename, SearchOptions options )

Performs a user-facing file search on the mapped content directories.

Parameter(s):

filename - The name of the file to search for.
options - A bitwise OR of the options to use for filtering the results.

Return Value:

A container consisting of DzAsset instances for any files found during the search.

See Also:

DzScriptHandle

DzSearchContainer : searchForAssetAddOns( DzAsset asset, String filterText, Array categories, SortType sorting )

Performs a user-facing asset search on the content database, where the results are confined to those that indicate they are compatible with the compatibility base of the specified asset.

Parameter(s):

asset - The context asset; the asset to find addons for.
filterText - The text to use for filtering the results.
categories - A list of category paths to use for filtering the results.
sorting - The sorting filter index to use for ordering the results.
- 0 = None,
- 1 = Name,
- 2 = Date Purchased,
- 3 = Date Installed,
- 4 = Date Created,
- 5 = Release Date,
- 6 = Last Update,
- 7 = Group ID,
- 8 = Product ID (SKU),
- For Descending add 0x80000000 to the value

Return Value:

A container consisting of any DzAsset instances found during the search.

See Also:

DzScriptHandle

Since:

4.9.0.32

DzSearchContainer : searchForAssets( String filterText, Array categories, Array compatibilityBases, Array contentTypes, SortType sorting )

Performs a user-facing asset search on the content database.

Parameter(s):

filterText - The text to use for filtering the results.
categories - A list of category paths to use for filtering the results.
compatibilityBases - A list of compatibility bases to use for filtering the results.
contentTypes - A list of content types to use for filtering the results.
sorting - The sorting filter index to use for ordering the results.
- 0 = None,
- 1 = Name,
- 2 = Date Purchased,
- 3 = Date Installed,
- 4 = Date Created,
- 5 = Release Date,
- 6 = Last Update,
- 7 = Group ID,
- 8 = Product ID (SKU),
- For Descending add 0x80000000 to the value

Return Value:

A container consisting of any DzAsset instances found during the search.

See Also:

DzScriptHandle

Since:

4.9.0.32

DzSearchContainer : searchForAssetsByKeywords( String keywords, SearchOptions options, SortType sorting )

Performs a user-facing asset search on the content database.

Parameter(s):

keywords - The keywords to use for filtering the results.
options - A bitwise OR of the options to use for filtering the results.
sorting - The sorting filter index to use for ordering the results.
- 0 = None,
- 1 = Name,
- 2 = Date Purchased,
- 3 = Date Installed,
- 4 = Date Created,
- 5 = Release Date,
- 6 = Last Update,
- 7 = Group ID,
- 8 = Product ID (SKU),
- For Descending add 0x80000000 to the value

Return Value:

A container consisting of any DzAsset instances found during the search.

See Also:

DzScriptHandle

Since:

4.9.0.32

DzSearchContainer : searchForAssetsInCategory( String categoryPath, Boolean userFacing=true, Boolean installed=true )

Parameter(s):

categoryPath - The full path of the category to search for assets.
userFacing - Whether or not to limit the search to user-facing assets. (since 4.9.3.56)
installed - Whether or not to limit the search to installed assets. (since 4.9.3.56)

Return Value:

A search container containing the assets matching the criteria specified.

See Also:

DzScriptHandle

Since:

4.9.1.17

DzSearchContainer : searchForAssetTargets( DzAsset asset, String filterText, Array categories, SortType sorting )

Performs a user-facing asset search on the content database, where the results are confined to those that indicate they are the compatibility base of the specified asset.

Parameter(s):

asset - The context asset; the asset to find targets for.
filterText - The text to use for filtering the results.
categories - A list of category paths to use for filtering the results.
sorting - The sorting filter index to use for ordering the results.
- 0 = None,
- 1 = Name,
- 2 = Date Purchased,
- 3 = Date Installed,
- 4 = Date Created,
- 5 = Release Date,
- 6 = Last Update,
- 7 = Group ID,
- 8 = Product ID (SKU),
- For Descending add 0x80000000 to the value

Return Value:

A container consisting of any DzAsset instances found during the search.

See Also:

DzScriptHandle

Since:

4.9.0.32

DzSearchContainer : searchForProductAssets( DzProductAssetContainer product, String filterText, Array categories, Array compatibilityBases, Array contentTypes, SortType sorting )

Performs a user-facing asset search on the content database, where the results are confined to a specified product.

Parameter(s):

product - The context product; the product to filter results by.
filterText - The text to use for filtering the results.
categories - A list of category paths to use for filtering the results.
compatibilityBases - A list of compatibility bases to use for filtering the results.
contentTypes - A list of content types to use for filtering the results.
sorting - The sorting filter index to use for ordering the results.
- 0 = None,
- 1 = Name,
- 2 = Date Purchased,
- 3 = Date Installed,
- 4 = Date Created,
- 5 = Release Date,
- 6 = Last Update,
- 7 = Group ID,
- 8 = Product ID (SKU),
- For Descending add 0x80000000 to the value

Return Value:

A container consisting of any DzAsset instances found during the search.

See Also:

DzScriptHandle

Since:

4.9.0.32

DzProductHolderContainer : searchForProducts( String filterText, Array categories, Array compatibilityBases, Array contentTypes, ProductInstallStates installStateFlags, SortType sorting )

Parameter(s):

filterText - The text to use for filtering the results.
categories - A list of category paths to use for filtering the results.
compatibilityBases - A list of compatibility bases to use for filtering the results.
contentTypes - A list of content types to use for filtering the results.
installStateFlags - The install state flags to use for filtering the results.
- None = 0x0,
- Installed = 0x1,
- NotInstalled = 0x2,
- Damaged = 0x4,
- NeedsUpdate = 0x8,
- Pending = 0x10,
- Any = Installed | NotInstalled | Damaged | NeedsUpdate | Pending
sorting - The sorting filter index to use for ordering the results.
- 0 = None,
- 1 = Name,
- 2 = Date Purchased,
- 3 = Date Installed,
- 4 = Date Created,
- 5 = Release Date,
- 6 = Last Update,
- 7 = Group ID,
- 8 = Product ID (SKU),
- For Descending add 0x80000000 to the value

Return Value:

An asset container where child containers are the DzProductAssetContainer instances found during the search. DzTopLevelAssetContainer::getState() should be called, in a while loop, on the return value and compared for equality with the DzTopLevelAssetContainer::csBusy state. While the state is busy, results of the search are still being added.

See Also:

DzScriptHandle

Since:

4.9.0.32

Array : selectCategoryPaths( Boolean multiSelect=false, Array startWith=[], String title=“”, String settingsName=“” )

Presents the user with a category selection dialog.

Parameter(s):

multiSelect - Whether or not to allow multiple selection.
startWith - A list of the category paths (if any) to start with. If multiSelect is false, the first element in the list is used.
title - The text to display for the title of the dialog. If set to an empty string (default), the default title for the dialog will be used.
settingsName - The base name of the settings to store to/restore from. If set to an empty string (default), the default will be used.

Return Value:

A list of the selected category path(s).

Since:

4.15.0.16

Array : selectCompatibilityBasePaths( Boolean showFilters=true, Boolean multiSelect=false, Array startWith=[], String title=“”, String settingsName=“” )

Presents the user with a compatibility base selection dialog.

Parameter(s):

showFilters - Whether or not to include compatibility filters.
multiSelect - Whether or not to allow multiple selection.
startWith - A list of the compatibility paths (if any) to start with. If multiSelect is false, the first element in the list is used.
title - The text to display for the title of the dialog. If set to an empty string (default), the default title for the dialog will be used.
settingsName - The base name of the settings to store to/restore from. If set to an empty string (default), the default will be used.

Return Value:

A list of the selected compatibility base(s).

Since:

4.15.0.16

void : setCMSOptions( String clusterDirectory, Number port )

Sets the options for the Content Management Service (CMS), if it is of the type that can accept options.

Parameter(s):

clusterDirectory - The path of the directory that contains the database files.
port - The port number to use for connecting to the database server.

void : setGroupNewProductsAsNew( Boolean onOff )

Parameter(s):

onOff - If true, new products will be assigned to the “New” group.

See Also:

getGroupNewProductsAsNew()

Since:

4.9.0.23

void : setMaxFileSearchResultSize( Number maxNum )

Parameter(s):

maxNum - The maximum number of items to return from a standard file search.

See Also:

getMaxFileSearchResultsSize()

Since:

4.9.0.15

void : setMaxItemsPerPage( Number maxNum )

Parameter(s):

maxNum - The maximum number of items to show on a page in the content view

See Also:

getNumMaxItemsPerPage()

void : setProductGroupIDs( Array guids, Number groupId, Boolean groupProduct=true, Boolean groupFiles=true )

Sets the group identifier on products and/or files, for a list of products.

Parameter(s):

guids - A list of guids for the products to set the group identifier on.
groupId - The group identifier to set.
groupProduct - If true, sets the group identifier on the product.
groupFiles - If true, sets the group identifier on the user-facing files in the product.

Since:

4.9.0.25

void : setShowAssetToolTip( Boolean onOff )

Parameter(s):

onOff - Whether or not to show tool tips on assets.

See Also:

showAssetToolTip()

void : setShowExtensions( Boolean onOff )

Parameter(s):

onOff - Whether or not to show extensions on assets.

See Also:

showExtensions()

void : setShowHiddenVendorCategorization( Boolean shown )

Sets whether or not hidden vendor categorizations are shown.

Parameter(s):

shown - If true, hidden vendor categorizations are shown.

Since:

4.9.3.4

void : setShowLargeIcons( Boolean onOff )

Parameter(s):

onOff - Whether or not to show large icons.

See Also:

showLargeIcons()

Boolean : showAssetToolTip()

Return Value:

true if showing asset tool tips, otherwise false.

See Also:

setShowAssetToolTip()

Boolean : showDatabaseEditor( DzAbstractAssetContainer assetContainer )

Causes the Content DB Editor to be displayed, allowing the user to view/edit metadata for products and/or assets all within a centralized dialog.

Parameter(s):

assetContainer - The asset container to load into the editor. If the asset container is a DzProductAssetContainer, the dialog will display two pages: one for the product specific data, and one for the asset specific data. If the asset container is any other type, only the page for the asset specific data is displayed.

Return Value:

true if the dialog is accepted, otherwise false.

Boolean : showExtensions()

Return Value:

true if showing asset file extensions, otherwise false.

See Also:

setShowExtensions()

Boolean : showLargeIcons()

Return Value:

true if showing large asset icons, otherwise false.

See Also:

setShowLargeIcons()

void : showMoreProductInfo( DzProductAssetContainer product )

Executes a script named after the store associated with product, in the ./resources/stores directory. A single anonymous JSON object is passed to the script, which can be retrieved using the global “getArguments()” function. The properties on the Object consist of values stored in the content database.

store_id - A String containing the identifier for the store product is associated with.
store_token - A String containing the token in store_url to be replaced by product_token.
store_url - A String containing the URL with more information about product.
product_token - A String containing the token (SKU) from product.
product_name - A String containing the name of product.
product_artists - An Array of String values containing the names of artists that contributed to product.
product_description - A String containing the description of product.
product_guid - A String containing the Globally Unique Identifier for product.
product_is_vendor - A Boolean indicating whether product is provided by a vendor or the user.
product_has_cloud_meta - A Boolean indicating whether product has metadata provided via the cloud (or manual/local).
product_is_cloud_owned - A Boolean indicating whether product is managed via the cloud (or manual/local).

Parameter(s):

product - The product to show more information for.

See Also:

createStore()
DzApp::getResourcesPath()
DzScriptContext::getArguments()
./resources/stores/default.dsa

Since:

4.8.1.70

void : startCMS()

Starts the Content Management Service (CMS), if it is not already running.

void : stopAllSearches()

Stops all searches that were started by any of the search* methods on DzAssetMgr.

void : stopCMS( StopModeCMS mode, Boolean wait, Number timeout=0 )

Stops the Content Management Service (CMS), if it is running and is of the type that can be stopped.

Parameter(s):

mode - The mode to use to stop the service.
wait - Whether or not to wait for the CMS to stop before continuing.
timeout - The number of seconds to wait for the service to stop before continuing.

void : stopFileScan()

Stops any searches that were started by DzAssetMgr::scanFiles().

void : stopFileSearch()

Stops any searches that were started by DzAssetMgr::searchFiles().

void : stopSearchForAssetAddOns()

Stops any searches that were started by DzAssetMgr::searchForAssetAddOns().

void : stopSearchForAssets()

Stops any searches that were started by DzAssetMgr::searchForAssets(), DzAssetMgr::searchForAssetsByKeywords() or DzAssetMgr::searchForProductAssets().

void : stopSearchForAssetTargets()

Stops any searches that were started by DzAssetMgr::searchForAssetTargets().

void : stopSearchForProducts()

Stops any searches that were started by DzAssetMgr::searchForProducts().

void : updateCategoryContainers()

Triggers an update to asset containers within the Categories top-level container.

See Also:

getCategories()

Since:

4.8.1.65

void : updateContentContainers()

Triggers an update to asset containers within the native formats top-level container.

See Also:

getContentDirs()

Since:

4.8.1.65

void : updateFolderBasedContainers()

Triggers an update to asset containers within the folder based top-level containers.

See Also:

getContentDirs()
getPoserDirs()
getImportDirs()

Since:

4.8.1.65

void : updateImportContainers()

Triggers an update to asset containers within the other import formats top-level container.

See Also:

getImportDirs()

Since:

4.8.1.65

void : updatePoserContainers()

Triggers an update to asset containers within the Poser formats top-level container.

See Also:

getPoserDirs()

Since:

4.8.1.65

void : updateProductContainers()

Triggers an update to asset containers within the Products top-level container.

See Also:

getProducts()

Boolean : vacuumDatabase()

Reclaims space in the database previously occupied by deleted or updated data.

Return Value:

true if the operation was successful, otherwise false.

Signals

void : basePathsChanged()

Signature:“basePathsChanged()”

Emitted when the base paths list has changed.

void : categoryUpdate( Array idPath )

Signature:“categoryUpdate(QVariantList)”

Emitted when a category has been changed.

Parameter(s):

idPath - The list of ids leading to the changed category.

void : cmsDSNChanged()

Signature:“cmsDSNChanged()”

Emitted when the Data Source Name (DSN) for the Content Management Service (CMS) has changed.

void : cmsStarted()

Signature:“cmsStarted()”

Emitted when the Content Management Service (CMS) has started.

void : cmsStopped()

Signature:“cmsStopped()”

Emitted when the Content Management Service (CMS) has stopped.

void : compatibilityBaseListChanged()

Signature:“compatibilityBaseListChanged()”

Emitted when the compatibility base list has changed.

void : containerUpdate( Array idPath )

Signature:“containerUpdate(QVariantList)”

Emitted when a container has been changed.

Parameter(s):

idPath - The list of ids leading to the changed container.

void : groupNewProductsAsNewChanged()

Signature:“groupNewProductsAsNewChanged()”

Emitted when getGroupNewProductsAsNew() will return a new value.

void : itemsPerPageChanged( Number newPerPage )

Signature:“itemsPerPageChanged(int)”

Emitted when itemsPerPage() will return a new value.

Parameter(s):

newPerPage - The number of items to show per page.

void : maxFileSearchResultSizeChanged( Number maxFileSearchResultSize )

Signature:“maxFileSearchResultSizeChanged(int)”

Emitted when the maximum file search result size has changed.

Parameter(s):

maxFileSearchResultSize - The new maximum.

void : productCreated( String guid )

Signature:“productCreated(const QString &)”

Emitted when a product has been created.

Parameter(s):

guid - The Globally Unique Identifier (GUID) for the created product.

void : showAssetToolTipChanged()

Signature:“showAssetToolTipChanged()”

Emitted when showAssetToolTipChanged() will return a new value.

void : showExtensionsChanged()

Signature:“showExtensionsChanged()”

Emitted when showExtensions() will return a new value.

void : showHiddenVendorCategorizationChanged()

Signature:“showHiddenVendorCategorizationChanged()”

Emitted when getShowHiddenVendorCategorization() will return a new value.

void : showLargeIconsChanged()

Signature:“showLargeIconsChanged()”

Emitted when showLargeIcons() will return a new value.

void : storeListChanged()

Signature:“storeListChanged()”

Emitted when the store list has changed.

void : typeListChanged()

Signature:“typeListChanged()”

Emitted when the type list has changed.

void : uiAboutToSearch( QObject sender, String text, Array categories, Array compatibilityBases, Array contentTypes )

Signature:“uiAboutToSearch(int)”

Emitted when the user interface is about to perform a database query.

Parameter(s):

sender - The UI component that invoked the query.
text - The search text entered by the user.
categories - The categories to limit the query to.
compatibilityBases - The compatibility bases to limit the query to.
contentTypes - The content types to limit the query to.

DzAudioClip

2017-09-11T05:02:20+00:00

DzAudioClip

Class that encapsulates audio playback.

More...

Inherits :

Properties

DAZ Script
DzTime	currentPosition
String	filename
DzTime	length
Number	rate

Methods

DAZ Script
DzError	openFile ( String filename )
void	pause ()
void	play ()
void	reset ()

Detailed Description

This class is implemented by platform specific audioclip classes, winaudioclip_dz and macaudioclip_dz.

See Also:

DzScene::getAudio(), DzScene::setAudio(), DzAudioImporter, DzMultiMediaMgr::importAudioClip()

Properties

DzTime : currentPosition

The current position of the audio clip from the start.

String : filename

The name of the file the audio clip was loaded from (Read Only)

DzTime : length

The length of the audio clip (Read Only)

Number : rate

The current rate multiplier for the audio clip

Methods

DzError : openFile( String filename )

Opens the file specified by filename and sets up the audio clip.

Parameter(s):

filename - The name of the audio file to load.

Return Value:

true if the file was successfully opened, false otherwise;

void : pause()

Pauses the audio clip without resetting current position.

void : play()

Plays the audio clip from current position.

void : reset()

Resets the current position of the audio clip to the beginning.

DzAudioImporter

2017-09-11T05:02:20+00:00

DzAudioImporter

Base class for all audio clip importers.

More...

Inherits :

QObject
- DzBase
  - DzFileIO

Methods

DAZ Script
String	getDescription ()
String	getExtension ()
DzError	loadAudio ( String filename, DzAudioClip clip, DzFileIOSettings options )
DzError	loadAudio ( String filename, DzAudioClip clip )
Boolean	recognize ( String filename )

Detailed Description

See Also:

DzMultiMediaMgr

Methods

String : getDescription()

Return Value:

A description of the importer that can be placed in a file type selection combo box (e.g. “WAV Format”).

String : getExtension()

Return Value:

The file extension (excluding the preceding dot) supported by this importer.

DzError : loadAudio( String filename, DzAudioClip clip, DzFileIOSettings options )

TODO: Add description.

DzError : loadAudio( String filename, DzAudioClip clip )

Reads the file.

Parameter(s):

filename - Name of the file to be read.
clip - Audio clip to read data into.

Return Value:

DZ_NO_ERROR on success, otherwise an error code.

Boolean : recognize( String filename )

Test the given filename and file contents to see if this importer can read it.

Parameter(s):

filename - The name of the file to test.

Return Value:

true if the importer can import the file, otherwise false.

DzAuthenticationMgr

2022-05-24T21:43:39+00:00

DzAuthenticationMgr

Manager that is responsible for authentication of a Daz 3D user account.

More...

Inherits :

QObject

Methods

DAZ Script
Boolean	authenticateUser ()
String	getUserToken ()
Boolean	isAuthenticated ()
Boolean	isLoggingIn ()
void	logout ()

Signals

void	beginLogin ()
void	beginLogout ()
void	currentAccountChanged ()
void	loggedIn ()
void	loggedOut ()

Detailed Description

This class does not provide access to any Daz 3D user account information which could be considered an invasion of the user's privacy. This class does provide plugins and scripts with an ability to check if a user has authenticated (logged in to) a Daz 3D account, to prompt a user to authenticate (login to) their Daz 3D account, to obtain a token that uniquely and anonymously identifies the current/last account authenticated, and to logout of an account that is currently logged in.

There is only one instance of this manager in an application. This instance is created and owned by DzApp. Request the instance via DzApp::getAuthenticationMgr().

See Also:

Global::App
Sample: Retrieve User Token

Methods

Boolean : authenticateUser()

This function will attempt to authenticate a Daz 3D user account. If no account information has been entered by the user, a dialog will be displayed to securely acquire the username and password to be authenticated.

Return Value:

true if the user was authenticated, otherwise false.

String : getUserToken()

Return Value:

If the user has (not necessarily is) logged in to a Daz 3D user account and the application has a valid connection to the database, a token that represents the account that the user last logged into is returned. If the user has not logged into a Daz 3D user account or the application does not have a valid connection to the database, an empty string is returned.

Attention:

This function existed prior to 4.9.3.66 but it was deprecated as part of a much older implementation and it would only return an empty string. As of 4.9.3.66 the function has been revived and the function operates as described above.

See Also:

DzAssetMgr::haveDatabase()
Sample: Retrieve User Token

Boolean : isAuthenticated()

Return Value:

true if the user is authenticated (currently logged in), otherwise false.

Boolean : isLoggingIn()

Return Value:

true if in process of logging in, otherwise false. The event queue must execute to finish login.

Since:

4.9.3.71

void : logout()

Invalidates any existing authentication.

Signals

void : beginLogin()

Signature:“beginLogin()”

Emitted when the user begins to login to a Daz 3D account.

void : beginLogout()

Signature:“beginLogout()”

Emitted when the user begins to log out of a Daz 3D account.

void : currentAccountChanged()

Signature:“currentAccountChanged()”

Emitted when the current Daz 3D account in use changes.

void : loggedIn()

Signature:“loggedIn()”

Emitted after the user has successfully logged in to a Daz 3D account.

void : loggedOut()

Signature:“loggedOut()”

Emitted after the user has successfully logged out of a Daz 3D account.

DzAuthor

2022-05-26T07:06:05+00:00

DzAuthor

Encapsulates authorship information.

More...

Inherits :

Object

Properties

DAZ Script
String	email
String	name
String	url
String	valid

Constructors

DAZ Script
DzAuthor ()
DzAuthor ( String author )
DzAuthor ( DzAuthor author )
DzAuthor ( String name, String email, String url=“” )

Detailed Description

DzAuthor is used to access authorship data for native files, and the current instance of the application.

See Also:

Properties

String : email

Deprecated

Exists only to keep old code working.

String : name

The author's name. (Read Only)

String : url

The author's url. (Read Only)

String : valid

true if name contains valid information, otherwise false. (Read Only)

Constructors

DzAuthor()

Default constructor. Creates an empty author.

DzAuthor( String author )

Creates an author by parsing a string.

Parameter(s):

author - A string representation of the author in the form "[ name, email, url ]"

DzAuthor( DzAuthor author )

Copy Constructor.

Parameter(s):

author - The author information to copy.

DzAuthor( String name, String email, String url=“” )

Create a DzAuthor with the given name, email, and url.

Parameter(s):

name - The name of the author.
email - The author's email address.
url - The author's home page URL.

DzBackdrop

2022-05-24T21:41:43+00:00

DzBackdrop

Backdrop that gets drawn behind viewport scenes.

More...

Inherits :

QObject
- DzBase
  - DzElement

Enumerations

DAZ Script
Rotation	{ NO_ROTATION, ROTATE_LEFT_90, ROTATE_RIGHT_90, ROTATE_180 }

Properties

DAZ Script
Color	backgroundColor
Boolean	flipHorizontal
Boolean	flipVertical
Rotation	rotation
Boolean	visible
Boolean	visibleInRender

Constructors

DAZ Script
DzBackdrop ()

Methods

DAZ Script
void	adjustRenderAspectRatioToMatchTexture ()
void	adjustRenderDimensionsToMatchTexture ()
void	clear ()
DzColorProperty	getBackgroundColorControl ()
DzBoolProperty	getHorizontalFlipControl ()
DzMaterial	getMaterial ()
DzEnumProperty	getRotationControl ()
DzTexture	getTexture ()
DzBoolProperty	getVerticalFlipControl ()
DzBoolProperty	getVisibleControl ()
DzBoolProperty	getVisibleInRenderControl ()
void	setTexture ( DzTexture img )
void	showOptions ( QWidget parent=undefined )

Signals

void	backgroundColorChanged ()
void	drawnDataChanged ()
void	visiblityChanged ()

Detailed Description

This class encapsulates a 2D image and the parameters for drawing the image as a backdrop for the scene. An instance of this class only contributes to the scene if it is set as the current backdrop for the scene.

See Also:

DzScene::setBackdrop()
DzScene::getBackdrop()

Enumerations

: Rotation

Enumerated image rotation types

NO_ROTATION - No rotation
ROTATE_LEFT_90 - 90 degree rotation Counter-Clockwise
ROTATE_RIGHT_90 - 90 degree rotation Clockwise
ROTATE_180 - 180 degree rotation

Properties

Color : backgroundColor

Holds the background color of the backdrop.

Since:

4.6.4.30

Boolean : flipHorizontal

Holds whether or not the backdrop is flipped horizontally.

Boolean : flipVertical

Holds whether or not the backdrop is flipped vertically.

Rotation : rotation

Holds the rotation applied to the backdrop.

Boolean : visible

Holds whether or not the backdrop is visible in the viewport.

Since:

4.6.4.30

Boolean : visibleInRender

Holds whether or not the backdrop is visible in a render.

Since:

4.6.4.32

Constructors

DzBackdrop()

Default Constructor.

Methods

void : adjustRenderAspectRatioToMatchTexture()

Changes the render aspect ratio to match the backdrop image, and the image dimensions.

Since:

4.6.4.33

void : adjustRenderDimensionsToMatchTexture()

Changes the render image dimensions and aspect ratio to match the backdrop image.

Since:

4.6.4.33

void : clear()

Clears the current back drop image, and resets all parameters.

Example:

// Get the backdrop for the scene
var oBackdrop = Scene.getBackdrop();
 
// Clear the backdrop
oBackdrop.clear();

DzColorProperty : getBackgroundColorControl()

Return Value:

The property that controls the backdrop color or tinting.

Since:

4.6.4.35

DzBoolProperty : getHorizontalFlipControl()

Return Value:

The property that controls whether the backdrop is flipped horizontally.

DzMaterial : getMaterial()

Return Value:

An editable instance of the material used to shade the backdrop.

Example:

// Get the backdrop for the scene
var oBackdrop = Scene.getBackdrop();
// Get the material for the backdrop
var oMaterial = oBackdrop.getMaterial();
 
// Set the color of the backdrop to red
oMaterial.setDiffuseColor( new Color( 255, 0, 0 ) );

DzEnumProperty : getRotationControl()

Return Value:

The property that controls rotation of the backdrop.

DzTexture : getTexture()

Return Value:

The current backdrop image.

Example:

// Get the backdrop for the scene
var oBackdrop = Scene.getBackdrop();
// Get the texture for the backdrop
var oTexture = oBackdrop.getTexture();
 
// Log the file name of the current backdrop image
if ( oTexture ){
	print( String( "Current Backdrop: %1" ).arg( oTexture.getFilename() ) );
} else {
	print( "No Current Backdrop Image" );
}

See Also:

setTexture()

DzBoolProperty : getVerticalFlipControl()

Return Value:

The property that controls whether the backdrop is flipped vertically.

DzBoolProperty : getVisibleControl()

Return Value:

The property that controls whether the backdrop is visible.

Since:

4.6.4.32

DzBoolProperty : getVisibleInRenderControl()

Return Value:

The property that controls whether the backdrop is visible in a render.

Since:

4.6.4.32

void : setTexture( DzTexture img )

Sets the backdrop image.

Parameter(s):

img - The backdrop image.

Example:

// Get the backdrop for the scene
var oBackdrop = Scene.getBackdrop();
// Get the image manager
var oImageMgr = App.getImageMgr();
 
// Get an image
var sImage = String( "%1/../Pictures/Sample Pictures/Desert.jpg" ).arg( App.getCommonUserDocumentPath() );
var oImage = oImageMgr.getImage( sImage );
 
// Set the backdrop image
oBackdrop.setTexture( oImage );
// Make the backdrop visible
oBackdrop.visible = true;

See Also:

getTexture()

void : showOptions( QWidget parent=undefined )

Deprecated

Shows the options dialog for this backdrop.

Example:

// Get the backdrop for the scene
var oBackdrop = Scene.getBackdrop();
 
// Display options for the backdrop to the user
oBackdrop.showOptions( MainWindow );

Signals

void : backgroundColorChanged()

Signature:“backgroundColorChanged()”

Emitted when the background color of this backdrop changes.

Since:

4.6.4.30

void : drawnDataChanged()

Signature:“drawnDataChanged()”

Emitted when the information in this backdrop changes.

void : visiblityChanged()

Signature:“visiblityChanged()”

Emitted when the visibility of this backdrop changes.

Since:

4.6.4.32

DzBase

2022-05-24T23:01:56+00:00

DzBase

Base class for a considerable portion of the Daz Studio API.

More...

Inherits :

QObject

Inherited By : DzAppSettings, DzAssetMgr, DzAudioClip, brickparam_dz, DzContentFolder, DzContentMgr, DzController, DzCustomData, DzDrawStyle, DzElement, DzFileIO, DzIndexList, DzInstanceGroupItem, iraycanvasdefinition_dz, DzLayeredImage (deprecated), DzLegacyIKChain, materialselectionset_dz, DzPresentation, DzProperty, DzPropertyGroup, DzPropertyGroupTree, DzRenderer, DzRenderMgr, rigiditygroup_dz, DzRSLShader, DzScene, DzScript, DzScriptContext, DzSelectionMap, DzSimulationEngine, DzSimulationMgr, DzStorable (deprecated), texturebakermgr_dz, textureconvertormgr_dz, DzTextureModifier, DzViewTool and DzWeld

Methods

DAZ Script
void	makePersistent ()

Signals

void	nameChanged ( String name )

Detailed Description

Derived from QObject, this base class allows for the use of the signals-slots architecture provided by the Qt framework, within the Daz Studio API.

A considerable portion of classes in the Daz Studio API derive from this class.

Methods

void : makePersistent()

Provides scripts a way to make objects persistent; i.e., so that Qt will not delete them when they are no longer referenced by the script. This allows object instances to be created in script, then passed into the core and remain after the script has finished execution.

Signals

void : nameChanged( String name )

Signature:“nameChanged(const QString&)”

Emitted when the internal name of the object has changed.

Parameter(s):

name - The new name of the object.

DzBasicCamera

2022-05-24T23:00:44+00:00

DzBasicCamera

A basic camera.

More...

Inherits :

QObject
- DzBase
  - DzElement
    - DzNode
      - DzCamera

Inherited By : DzShaderCamera

Properties

DAZ Script
Number	currentViewHeight
Number	currentViewWidth
Boolean	depthOfField
Number	farDofPlane
Number	fStop
Boolean	isPerspective
Number	nearDofPlane
Boolean	useActiveViewport

Constructors

DAZ Script
DzBasicCamera ()

Methods

DAZ Script
Boolean	applyDimensionsPreset ( String preset )
DzVec3	cursorToRay ( Number x, Number y )
DzVec3	cursorToScene ( Number x, Number y, Number z )
DzFloatProperty	getApertureBladeRotationAngleControl ()
DzIntProperty	getApertureNumBladesControl ()
DzFloat2Property	getAspectRatioControl ()
DzBoolProperty	getConstrainProportionsControl ()
DzBoolProperty	getDepthOfFieldControl ()
DzStringProperty	getDimensionPresetControl ()
Boolean	getDimensionsPreset ( String preset, DzSettings settings )
DzBoolProperty	getDisplayPersistenceControl ()
DzColorProperty	getDofOverlayColorControl ()
DzFloatProperty	getDofOverlayOpacityControl ()
DzColorProperty	getDofPlaneColorControl ()
DzBoolProperty	getDofPlaneVisibilityControl ()
DzBoolProperty	getFarDofPlaneVisibilityControl ()
DzFloatProperty	getFocalDistanceControl ()
DzFloatProperty	getFocalLengthControl ()
DzFloatProperty	getFocalPointScaleControl ()
DzColorProperty	getFovColorControl ()
DzFloatProperty	getFovLengthControl ()
DzFloatProperty	getFovOpacityControl ()
DzFloatProperty	getFrameWidthControl ()
DzFloatProperty	getFStopControl ()
DzFloatProperty	getHeadlampIntensityControl ()
DzEnumProperty	getHeadlampModeControl ()
DzFloatProperty	getLensDistortionK1Control ()
DzFloatProperty	getLensDistortionK2Control ()
DzFloatProperty	getLensDistortionK3Control ()
DzFloatProperty	getLensDistortionK4Control ()
DzFloatProperty	getLensDistortionK5Control ()
DzFloatProperty	getLensDistortionScaleControl ()
DzEnumProperty	getLensDistortionTypeControl ()
DzFloatProperty	getLensMaximumFovControl ()
DzFloatProperty	getLensRadialBiasControl ()
DzFloatProperty	getLensShiftXControl ()
DzFloatProperty	getLensShiftYControl ()
DzFloatProperty	getLensStereoOffsetControl ()
DzFloatProperty	getLensThicknessControl ()
DzBoolProperty	getNearDofPlaneVisibilityControl ()
DzBoolProperty	getPerspectiveControl ()
DzInt2Property	getPixelSizeControl ()
DzFloatProperty	getSightLineOpacityControl ()
DzBoolProperty	getUseLocalDimensionsControl ()
DzFloatProperty	getXHeadlampOffsetControl ()
DzFloatProperty	getYHeadlampOffsetControl ()
DzFloatProperty	getZHeadlampOffsetControl ()
Boolean	isAtDefaultSceneCameraValues ()
Boolean	isDefaultSceneCamera ()
void	setIsDefaultSceneCamera ( Boolean yesNo )
void	setType ( DzCamera::CameraType type )
Deprecated
DzFloatProperty	getFrameWidthChannel ()
DzFloatProperty	getFocalLengthChannel ()
DzBoolProperty	getDepthOfFieldChannel ()
DzFloatProperty	getFocalDistChannel ()
DzFloatProperty	getFStopChannel ()
DzBoolProperty	getDisplayPersistenceChannel ()
DzFloatProperty	getSightLineOpacityChannel ()
DzFloatProperty	getFocalPointScaleChannel ()
DzColorProperty	getFovColorChannel ()
DzFloatProperty	getFovOpacityChannel ()
DzFloatProperty	getFovLengthChannel ()
DzBoolProperty	getDofVisibilityChannel ()
DzColorProperty	getDofColorChannel ()
DzColorProperty	getDofOverlayColorChannel ()
DzFloatProperty	getDofOverlayOpacityChannel ()
DzBoolProperty	getNearDofVisibilityChannel ()
DzBoolProperty	getFarDofVisibilityChannel ()

Signals

void	depthOfFieldChanged ()
void	fStopChanged ( DzTimeRange range )

Detailed Description

This is the basic camera implementation for DAZ Studio. It supplies commonly-used features like focal length adjustment and depth of field alteration.

Properties

Number : currentViewHeight

Holds the current height of the view. (Read Only)

Number : currentViewWidth

Holds the current width of the view. (Read Only)

Boolean : depthOfField

Holds whether or not the camera performs depth of field calculations.

Number : farDofPlane

Holds the distance of the far DOF plane from this camera. (Read Only)

Since:

4.15.1.84

Number : fStop

Holds the f/stop of the camera.

Boolean : isPerspective

Holds whether or the camera is a perspective or orthographic view.

Number : nearDofPlane

Holds the distance of the near DOF plane from this camera. (Read Only)

Since:

4.15.1.84

Boolean : useActiveViewport

Holds whether or not the local dimensions will use the active viewport when enabled.

Since:

4.9.3.108

Constructors

DzBasicCamera()

Create a camera.

Example:

(function(){
 
	// Create a new camera
	var oCamera = new DzBasicCamera();
 
	// Name the camera
	oCamera.setName( "My Camera" );
 
	// Set the type to orthographic, forward facing along the Z axis
	oCamera.setType( DzCamera.FRONT_CAMERA );
 
	// Add the camera to the scene
	Scene.addNode( oCamera );
 
})();

Methods

Boolean : applyDimensionsPreset( String preset )

Applies the settings in a dimensions preset.

Parameter(s):

preset - The name of the preset to retrieve the settings for. An empty string is interpreted to mean “Custom.”

Return Value:

true if preset was found, otherwise false.

Since:

4.9.3.108

DzVec3 : cursorToRay( Number x, Number y )

A ray through the scene for a perspective view.

Parameter(s):

x - The x position of the cursor in the viewport.
y - The y position of the cursor in the viewport.

Return Value:

A directional vector that defines a ray that intersects the camera's center point.

DzVec3 : cursorToScene( Number x, Number y, Number z )

Calculates a location in the scene based on an x, y position in the viewport and distance from the camera.

Parameter(s):

x - The x coordinate of the cursor in the viewport.
y - The y coordinate of the cursor in the viewport.
z - The distance from the camera in world space at which to calculate the target point.

Return Value:

A positional vector that represents the resulting location in the scene.

DzFloatProperty : getApertureBladeRotationAngleControl()

Return Value:

The “Aperture Blade Rotation” property for this camera.

Since:

4.9.3.121

DzIntProperty : getApertureNumBladesControl()

Return Value:

The “Aperture Blades” property for this camera.

Since:

4.9.3.121

DzFloat2Property : getAspectRatioControl()

Return Value:

The “Aspect Ratio” property for this camera.

Since:

4.15.1.84

DzBoolProperty : getConstrainProportionsControl()

Return Value:

The “Constrain Proportions” property for this camera.

Since:

4.15.1.84

DzBoolProperty : getDepthOfFieldControl()

Return Value:

The “Depth of Field” property for this camera.

Since:

4.15.1.84

DzStringProperty : getDimensionPresetControl()

Return Value:

The “Dimension Preset” property for this camera.

Since:

4.15.1.84

Boolean : getDimensionsPreset( String preset, DzSettings settings )

Retrieves the settings of a dimensions preset.

Parameter(s):

preset - The name of the preset to retrieve the settings for. An empty string is interpreted to mean “Custom.”
settings - The settings object that the settings will be assigned to.

Return Value:

true if preset was found, otherwise false.

Since:

4.9.3.108

DzBoolProperty : getDisplayPersistenceControl()

Return Value:

The “Display Persistence” property for this camera.

Since:

4.15.1.84

DzColorProperty : getDofOverlayColorControl()

Return Value:

The “DOF Overlay Color” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getDofOverlayOpacityControl()

Return Value:

The “DOF Overlay Opacity” property for this camera.

Since:

4.15.1.84

DzColorProperty : getDofPlaneColorControl()

Return Value:

The “DOF Plane Color” property for this camera.

Since:

4.15.1.84

DzBoolProperty : getDofPlaneVisibilityControl()

Return Value:

The “DOF Plane Visibility” property for this camera.

Since:

4.15.1.84

DzBoolProperty : getFarDofPlaneVisibilityControl()

Return Value:

The “Far DOF Plane Visibility” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getFocalDistanceControl()

Return Value:

The “Focal Distance” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getFocalLengthControl()

Return Value:

The “Focal Length (mm)” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getFocalPointScaleControl()

Return Value:

The “Focal Point Scale” property for this camera.

Since:

4.15.1.84

DzColorProperty : getFovColorControl()

Return Value:

The “FOV Color” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getFovLengthControl()

Return Value:

The “FOV Length” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getFovOpacityControl()

Return Value:

The “FOV Opacity” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getFrameWidthControl()

Return Value:

The “Frame Width (mm)” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getFStopControl()

Return Value:

The “F/Stop” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getHeadlampIntensityControl()

Return Value:

The “Headlamp Intensity” property for this camera.

Since:

4.7.1.94

DzEnumProperty : getHeadlampModeControl()

Return Value:

The “Headlamp Mode” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getLensDistortionK1Control()

Return Value:

The “Lens Distortion K1” property for this camera.

See Also:

getLensDistortionTypeControl() - poly3, inv_poly3, poly5, inv_poly5, ptlens, inv_ptlens, brown, inv_brown, equidistant

Since:

4.9.3.121

DzFloatProperty : getLensDistortionK2Control()

Return Value:

The “Lens Distortion K2” property for this camera.

See Also:

getLensDistortionTypeControl() - poly5, inv_poly5, ptlens, inv_ptlens, brown, inv_brown, equidistant

Since:

4.9.3.121

DzFloatProperty : getLensDistortionK3Control()

Return Value:

The “Lens Distortion K3” property for this camera.

See Also:

getLensDistortionTypeControl() - ptlens, inv_ptlens, brown, inv_brown, equidistant

Since:

4.9.3.121

DzFloatProperty : getLensDistortionK4Control()

Return Value:

The “Lens Distortion K4” property for this camera.

See Also:

getLensDistortionTypeControl() - brown, inv_brown, equidistant

Since:

4.16.1.19

DzFloatProperty : getLensDistortionK5Control()

Return Value:

The “Lens Distortion K5” property for this camera.

See Also:

getLensDistortionTypeControl() - equidistant

Since:

4.16.1.19

DzFloatProperty : getLensDistortionScaleControl()

Return Value:

The “Lens Distortion Scale” property for this camera.

Since:

4.9.3.121

DzEnumProperty : getLensDistortionTypeControl()

Return Value:

The “Lens Distortion Type” property for this camera.

Attention:

The radial distortion models define the relationship between the undistorted radial pixel coordinate ru and the distorted radial pixel coordinate rd with regards to the ideal perspective camera.
These options do not make use of “Lens Distortion K#” control values
- none : Conventional perspective camera.
- spherical : Conventional spherical camera mapping.
- cylindrical : Conventional cylindrical camera mapping.
These options make use of the value of getLensDistortionK1Control()
- poly3 : Third order radial distortion model

 rd = ru * (1 - k1 + k1 * ru2)

inv_poly3 : Third order inverse radial distortion model

 ru = rd * (1 - k1 + k1 * rd2)

These options also make use of the value of getLensDistortionK2Control()
- poly5 : Fifth order radial distortion model

 rd = ru * (1 + k1 * ru2 + k2 * ru4)

inv_poly5 : Fifth order inverse radial distortion model

 ru = rd * (1 + k1 * rd2 + k2 * rd4)

These options also make use of the value of getLensDistortionK3Control()
- ptlens : Fourth order radial distortion model

 rd = ru * (1 - k1 - k2 - k3 + k1 * ru + k2 * ru2 + k3 * ru3)

inv_ptlens : Fourth order inverse radial distortion model

 ru = rd * (1 - k1 - k2 - k3 + k1 * rd + k2 * rd2 + k3 * rd3)

These options also make use of the values of getLensDistortionK4Control() and getLensDistortionK5Control()
- brown : Fifth order radial distortion model

 rd = ru * (k1 + k2 * ru + k3 * ru2 + k4 * ru3 + k5 * ru4)

inv_brown : Fifth order inverse radial distortion model

 ru = rd * (k1 + k2 * rd + k3 * rd2 + k4 * rd3 + k5 * rd4)

equidistant : Equidistant fish-eye with a fourth order radial distortion model

 ru = k1 + k2 * rd + k3 * rd2 + k4 * rd3 + k5 * rd4

See also getLensMaximumFovControl()

Since:

4.9.3.121

DzFloatProperty : getLensMaximumFovControl()

Return Value:

The “Lens Maximum FOV” property for this camera.

See Also:

getLensDistortionTypeControl() - equidistant

Since:

4.16.1.19

DzFloatProperty : getLensRadialBiasControl()

Return Value:

The “Lens Radial Bias” property for this camera.

Since:

4.9.3.121

DzFloatProperty : getLensShiftXControl()

Return Value:

The “Lens Shift X” property for this camera in mm.

Since:

4.9.3.121

DzFloatProperty : getLensShiftYControl()

Return Value:

The “Lens Shift Y” property for this camera in mm.

Since:

4.9.3.121

DzFloatProperty : getLensStereoOffsetControl()

Return Value:

The “Lens Stereo Offset” for this camera in mm.

Since:

4.9.3.121

DzFloatProperty : getLensThicknessControl()

Return Value:

The “Lens Thickness” property for this camera. Thickness is in mm.

Since:

4.8.0.16

DzBoolProperty : getNearDofPlaneVisibilityControl()

Return Value:

The “Near DOF Plane Visibility” property for this camera.

Since:

4.15.1.84

DzBoolProperty : getPerspectiveControl()

Return Value:

The “Perspective” property for this camera.

Since:

4.15.1.84

DzInt2Property : getPixelSizeControl()

Return Value:

The “Pixel Size” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getSightLineOpacityControl()

Return Value:

The “Sight Line Opacity” property for this camera.

Since:

4.15.1.84

DzBoolProperty : getUseLocalDimensionsControl()

Return Value:

The “Use Local Dimensions” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getXHeadlampOffsetControl()

Return Value:

The “X Headlamp Offset” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getYHeadlampOffsetControl()

Return Value:

The “Y Headlamp Offset” property for this camera.

Since:

4.15.1.84

DzFloatProperty : getZHeadlampOffsetControl()

Return Value:

The “Z Headlamp Offset” property for this camera.

Since:

4.15.1.84

Boolean : isAtDefaultSceneCameraValues()

Return Value:

true if this camera is at default scene camera values, otherwise false.

Boolean : isDefaultSceneCamera()

Return Value:

true if this camera is the default scene camera, otherwise false.

void : setIsDefaultSceneCamera( Boolean yesNo )

Parameter(s):

yesNo - If true, sets this camera as the default scene camera.

Attention:

Assigning more than one camera as the default scene camera will not be preserved across save/load sequences.

void : setType( DzCamera::CameraType type )

Changes the type of the camera.

Parameter(s):

type - The new type for this camera.

DzFloatProperty : getFrameWidthChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getFrameWidthControl() instead.

DzFloatProperty : getFocalLengthChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getFocalLengthControl() instead.

DzBoolProperty : getDepthOfFieldChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getDepthOfFieldControl() instead.

DzFloatProperty : getFocalDistChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getFocalDistanceControl() instead.

DzFloatProperty : getFStopChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getFStopControl() instead.

DzBoolProperty : getDisplayPersistenceChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getDisplayPersistenceControl() instead.

DzFloatProperty : getSightLineOpacityChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getSightLineOpacityControl() instead.

DzFloatProperty : getFocalPointScaleChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getFocalPointScaleControl() instead.

DzColorProperty : getFovColorChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getFovColorControl() instead.

DzFloatProperty : getFovOpacityChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getFovOpacityControl() instead.

DzFloatProperty : getFovLengthChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getFovLengthControl() instead.

DzBoolProperty : getDofVisibilityChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getDofPlaneVisibilityControl() instead.

DzColorProperty : getDofColorChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getDofPlaneColorControl() instead.

DzColorProperty : getDofOverlayColorChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getDofOverlayColorControl() instead.

DzFloatProperty : getDofOverlayOpacityChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getDofOverlayOpacityControl() instead.

DzBoolProperty : getNearDofVisibilityChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getNearDofPlaneVisibilityControl() instead.

DzBoolProperty : getFarDofVisibilityChannel()

Deprecated

Exists only to keep old code working. Do not use in new code. Use getFarDofPlaneVisibilityControl() instead.

Signals

void : depthOfFieldChanged()

Signature:“projectionChanged()”

Emitted when the camera's depth of field setting has changed.

void : fStopChanged( DzTimeRange range )

Signature:“fStopChanged(const DzTimeRange&)”

Emitted when the camera's f-Stop setting has changed.

DzBasicDialog

2022-05-24T21:41:13+00:00

DzBasicDialog

A basic dialog that provides typical buttons found on most DAZ Studio dialogs.

More...

Inherits :

QObject
- DzWidget
  - DzDialog

Constructors

DAZ Script
DzBasicDialog ()

Methods

DAZ Script
void	addButton ( DzButton btn, Number index=1 )
void	addLayout ( DzLayout layout, Number stretch=0 )
void	addSpacing ( Number spacing )
void	addStretch ( Number stretch=0 )
void	addWidget ( DzWidget child, Number stretch=0, DzWidget::AlignmentFlags alignment=0 )
void	insertLayout ( Number index, DzLayout layout, Number stretch=0 )
void	insertWidget ( Number index, DzWidget child, Number stretch=0, DzWidget::AlignmentFlags alignment=0 )
void	setAcceptButtonAsDefault ()
void	setAcceptButtonEnabled ( Boolean onOff )
void	setAcceptButtonText ( String text )
void	setApplyButtonAsDefault ()
void	setApplyButtonEnabled ( Boolean onOff )
void	setApplyButtonText ( String text )
void	setCancelButtonAsDefault ()
void	setCancelButtonEnabled ( Boolean onOff )
void	setCancelButtonText ( String text )
void	setDefaultButton ( DzButton btn )
void	setHelpButtonAsDefault ()
void	setHelpButtonEnabled ( Boolean onOff )
void	showAcceptButton ( Boolean onOff )
void	showApplyButton ( Boolean onOff )
void	showCancelButton ( Boolean onOff )
void	showHelpButton ( Boolean onOff )
Deprecated
void	enableApplyButton ( Boolean onOff )
void	enableCancelButton ( Boolean onOff )
void	enableHelpButton ( Boolean onOff )

Signals

void	applyClicked ()

Detailed Description

The buttons provided by the dialog are: 'What's This', 'Apply', 'Accept', and 'Cancel'. Custom buttons can also be added to the set of default buttons by calling addButton(). All buttons but the 'Accept' button can be hidden or shown. By default, the 'Apply' button is the only hidden button. The text on the default buttons can be customized.

The dialog has a vertical box layout above the horizontal set of buttons. Widgets and sub-layouts can be added to this layout using addWidget() and addLayout().

See Also:

Constructors

DzBasicDialog()

Default Constructor. Creates a typical DAZ Studio dialog with 'What's This', 'Apply', 'Accept', and 'Cancel' buttons. By default, the 'Apply' button is hidden, call showApplyButton() to make it visible.

Methods

void : addButton( DzButton btn, Number index=1 )

Adds a button into the horizontal layout of the dialog's button bar.

Parameter(s):

btn - The button to add to the dialog's button layout.
index - The position in the button bar to insert the button.

void : addLayout( DzLayout layout, Number stretch=0 )

Adds a layout into the main vertical layout of the dialog.

Parameter(s):

child - The layout to add as a child of the dialog's main layout.
stretch - The stretch factor for the child layout.

void : addSpacing( Number spacing )

Adds spacing into the main vertical layout of the dialog.

Parameter(s):

spacing - The amount of spacing to add.

void : addStretch( Number stretch=0 )

Adds stretch into the main vertical layout of the dialog.

Parameter(s):

stretch - The stretch factor for the added stretchable space.

void : addWidget( DzWidget child, Number stretch=0, DzWidget::AlignmentFlags alignment=0 )

Adds a widget into the main vertical layout of the dialog.

Parameter(s):

child - The widget to add to the dialog's main layout.
stretch - The stretch factor for the child widget.
alignment - The alignment for the child widget.(since 4.9.3.93)

void : insertLayout( Number index, DzLayout layout, Number stretch=0 )

Inserts a layout into the main vertical layout of the dialog.

Parameter(s):

index - The index to insert the layout at.
layout - The layout to add to the dialog's main layout.
stretch - The stretch factor for the child layout.

Since:

4.12.1.28

void : insertWidget( Number index, DzWidget child, Number stretch=0, DzWidget::AlignmentFlags alignment=0 )

Inserts a widget into the main vertical layout of the dialog.

Parameter(s):

index - The index to insert the widget at.
child - The widget to add to the dialog's main layout.
stretch - The stretch factor for the child widget.
alignment - The alignment for the child widget.

Since:

4.9.3.93

void : setAcceptButtonAsDefault()

Sets the 'Accept' button is set as the default button for the dialog.

Since:

4.12.0.84

void : setAcceptButtonEnabled( Boolean onOff )

Enables or disables the Accept button. By default, the button is enabled.

Parameter(s):

onOff - If true, the 'Accept' button will be available to the user. If false, the button will not be shown.

void : setAcceptButtonText( String text )

Sets the text for the dialog's accept button. By default, the button is labelled 'Accept'.

Parameter(s):

text - The new label for the accept button.

void : setApplyButtonAsDefault()

Sets the 'Apply' button is set as the default button for the dialog.

Since:

4.12.0.84

void : setApplyButtonEnabled( Boolean onOff )

Enables or disables the Apply button. By default, the button is disabled.

Parameter(s):

onOff - If true, the 'Apply' button will be available to the user. If false, the button will not be shown.

void : setApplyButtonText( String text )

Sets the text for the dialog's apply button. By default, the button is labelled 'Apply'.

Parameter(s):

text - The new label for the apply button.

void : setCancelButtonAsDefault()

Sets the 'Cancel' button is set as the default button for the dialog.

Since:

4.12.0.84

void : setCancelButtonEnabled( Boolean onOff )

Enables or disables the Cancel button. By default, the button is enabled.

Parameter(s):

onOff - If true, the 'Cancel' button will be available to the user. If false, the button will not be shown.

void : setCancelButtonText( String text )

Sets the text for the dialog's cancel button. By default, the button is labelled 'Cancel'.

Parameter(s):

text - The new label for the cancel button.

void : setDefaultButton( DzButton btn )

Set the default button for the dialog.

Parameter(s):

btn - The button to set as the default for the dialog.

Since:

4.12.0.84

void : setHelpButtonAsDefault()

Sets the 'Help' button is set as the default button for the dialog.

Since:

4.12.0.84

void : setHelpButtonEnabled( Boolean onOff )

Enables or disables the Help button. By default, the button is enabled.

Parameter(s):

onOff - If true, the 'Help' button will be available to the user. If false, the button will not be shown.

void : showAcceptButton( Boolean onOff )

Shows or hides the 'Accept' button. By default, the button is shown.

Parameter(s):

onOff - If true, the 'Accept' button will be available to the user. If false, the button will not be shown.

void : showApplyButton( Boolean onOff )

Shows or hides the 'Apply' button. By default, the button is hidden.

Parameter(s):

onOff - If true, the 'Apply' button will be available to the user. If false, the button will not be shown.

void : showCancelButton( Boolean onOff )

Shows or hides the 'Cancel' button. By default, the button is shown.

Parameter(s):

onOff - If true, the 'Cancel' button will be available to the user. If false, the button will not be shown.

void : showHelpButton( Boolean onOff )

Shows or hides the 'What's This' button. By default, the button is shown.

Parameter(s):

onOff - If true, the 'What's This' button will be available to the user. If false, the button will not be shown.

void : enableApplyButton( Boolean onOff )

Deprecated

Exists only to keep old code working. Do not use in new code. Use showApplyButton() instead.

void : enableCancelButton( Boolean onOff )

Deprecated

Exists only to keep old code working. Do not use in new code. Use showCancelButton() instead.

void : enableHelpButton( Boolean onOff )

Deprecated

Exists only to keep old code working. Do not use in new code. Use showHelpButton() instead.

Signals

void : applyClicked()

Signature:“applyClicked()”

Emitted when the 'Apply' button is clicked by the user.

DzBone

2022-05-24T21:41:49+00:00

DzBone

Base class for all skeleton bone types.

More...

Inherits :

QObject
- DzBase
  - DzElement
    - DzNode

Constructors

DAZ Script
DzBone ()

Methods

DAZ Script
DzMatrix3	getBoneLocalScale ( DzTime tm )
DzBone	getFollowBone ()
Number	getFollowMode ()

Signals

void	followBoneChanged ( DzBone newFollowBone )

Detailed Description

This specialized DzNode subclass adds follow bone, and mesh-binding functionality to a node. All bones are assumed to be in the hierarchy of a DzSkeleton, and will not function properly if their parent is not a skeleton or another bone.

The concept of a follow bone allows the bones of one skeleton (figure) to follow another skeleton (figure). This following does not reproduce transforms from one bone to another, but tries to align center (origin) and end points so that the following bone points in the same direction as the bone it is following. Typically, this is controlled at the skeleton level.

Constructors

DzBone()

Default Constructor. Creates a new Bone node.

Methods

DzMatrix3 : getBoneLocalScale( DzTime tm )

Parameter(s):

tm - The time to get the local scale for.

Return Value:

The local scale of the bone at the given time.

DzBone : getFollowBone()

Get the node that this node is following.

Return Value:

The bone this bone is following, or NULL if this bone is not following another bone.

See Also:

DzSkeleton::getFollowTarget()

Number : getFollowMode()

Return Value:

The mode that this node is following by.

See Also:

DzSkeleton::getFollowMode()

Since:

4.8.0.23

Signals

void : followBoneChanged( DzBone newFollowBone )

Signature:“followBoneChanged(DzBone*)”

Emitted when the follow bone has changed.

DzBoneBinding

2022-05-26T07:17:31+00:00

DzBoneBinding

Specifies weight maps associated with an individual bone for a skin binding.

More...

Inherits :

QObject
- DzBase
  - DzElement

Constructors

Methods

Signals

Detailed Description

See Also:

DzSkinBinding

Constructors

Methods

Signals

Boolean

2017-09-11T05:01:58+00:00

Boolean

ECMAScript Boolean prototype object.

More...

Inherits :

Object

Methods

ECMAScript
String	toString ()
Number	valueOf ()

Detailed Description

ECMAScript provides a Boolean data type that can have one of two primitive values, true or false. In general, creating objects of this type is not recommended since the behavior will probably not be what you would expect. Instead, assign the literal value true or false as required.

Any expression can be evaluated in a boolean context (e.g. in logical operations, such as conditionals). If the expression's value is 0, null, false, NaN, undefined or an empty String, the expression is false; otherwise the expression is true.

Example:

Creating boolean values using the true/false constants

var bOn = true;
var bOff = false;

Example:

Creating a boolean values using the evaluation of expressions

var nVal1 = 5;
var nVal2 = 6;
var bEqual = (nVal1 == nVal2);
var bLessThan = (nVal1 < nVal2);
var bGreaterThan = (nVal1 > nVal2);

Methods

String : toString()

Return Value:

The value of the Boolean object as a String; i.e. “true” or “false”.

Number : valueOf()

Return Value:

The primitive value of the Boolean object; i.e. true or false.

DzBoolProperty

2017-09-11T05:02:17+00:00

DzBoolProperty

An animatable boolean property.

More...

Inherits :

QObject
- DzBase
  - DzProperty
    - DzNumericProperty
      - DzIntProperty

Constructors

DAZ Script
DzBoolProperty ()
DzBoolProperty ( String name, Boolean canAnimate, Boolean isUserProperty, Boolean initVal=true )

Methods

DAZ Script
Boolean	getBoolValue ()
Boolean	getDefaultBoolValue ()
void	setBoolValue ( Boolean value )
void	setDefaultBoolValue ( Boolean val )

Detailed Description

This class provides an animatable boolean property that is stored and can be accessed as an integer property. The integer value 0 is false, any other integer value is true.

Constructors

DzBoolProperty()

Default Constructor. Creates a non-animatable, non-user property.

DzBoolProperty( String name, Boolean canAnimate, Boolean isUserProperty, Boolean initVal=true )

Overloaded constructor.

Parameter(s):

name - The name of this property.
canAnimate - If true, creates an animatable property.
isUserProperty - If true, creates a user property; user properties are properties that can be added/deleted by users.
initVal - Sets the default value of the property.

Methods

Boolean : getBoolValue()

Return Value:

The boolean value of the property at the current time.

Boolean : getDefaultBoolValue()

Return Value:

The default boolean value of the property.

void : setBoolValue( Boolean value )

Sets the boolean value for this property at the current time - or the default value if this property is not animatable.

Parameter(s):

val - The new value for the property.

void : setDefaultBoolValue( Boolean val )

Sets the default boolean value for this property.

Parameter(s):

val - The new default value for the property.

DzBox3

2021-07-04T17:35:47+00:00

DzBox3

Describes a parametrically defined box in three dimensional space.

More...

Inherits :

Object

Properties

DAZ Script
DzVec3	max
Number	maxX
Number	maxY
Number	maxZ
DzVec3	min
Number	minX
Number	minY
Number	minZ

Constructors

DAZ Script
DzBox3 ()
DzBox3 ( String box )
DzBox3 ( Number xMin, Number yMin, Number zMin, Number xMax, Number yMax, Number zMax )
DzBox3 ( DzVec3 min, DzVec3 max )
DzBox3 ( DzBox3 box )

Methods

DAZ Script
DzVec3	closestPoint ( DzVec3 point )
Boolean	containsPoint ( DzVec3 point )
DzVec3	getCenter ()
Object	getIntersection ( DzLine3 ray )
Number	getSize ()
DzBox3	getTransformedBox ( DzMatrix3 matrix )
void	include ( DzVec3 vec )
void	include ( DzBox3 box )
Boolean	isValid ()
Boolean	testIntersection ( DzLine3 ray, Number tolerance )
String	toString ()
void	translate ( DzVec3 vec )

Detailed Description

Represents a three dimensional box by storing two three dimensional floating point vectors; an upper and lower corner for this box.

Properties

DzVec3 : max

Holds the maximum corner of this box.

Number : maxX

Holds the maximum value of this box on the x axis.

Number : maxY

Holds the maximum value of this box on the y axis.

Number : maxZ

Holds the maximum value of this box on the z axis.

DzVec3 : min

Holds the minimum corner of this box.

Number : minX

Holds the minimum value of this box on the x axis.

Number : minY

Holds the minimum value of this box on the y axis.

Number : minZ

Holds the minimum value of this box on the z axis.

Constructors

DzBox3()

Creates an uninitialized box - the first point included in an uninitialized box will become the min and max for this box.

DzBox3( String box )

Creates a box by parsing a string.

Parameter(s):

box - A string representation of the box in the form "[[ minX, minY, minZ ],[ maxX, maxY, maxZ ]]"

DzBox3( Number xMin, Number yMin, Number zMin, Number xMax, Number yMax, Number zMax )

Creates an initialized box with the given min and max values.

Parameter(s):

xmin - The minimum value for this box on the x axis.
ymin - The minimum value for this box on the y axis.
zmin - The minimum value for this box on the z axis.
xmax - The maximum value for this box on the x axis.
ymax - The maximum value for this box on the y axis.
zmax - The maximum value for this box on the z axis.

DzBox3( DzVec3 min, DzVec3 max )

Creates an initialized box with the given min and max values.

Parameter(s):

min - The minimum corner of this box.
max - The maximum corner of this box.

DzBox3( DzBox3 box )

Copy Constructor.

Parameter(s):

box - The box to copy.

Methods

DzVec3 : closestPoint( DzVec3 point )

Parameter(s):

point - The point to find the closest point in this box to.

Return Value:

The closest point in this box to point. Returns point if point is already in this box.

Since:

4.9.3.33

Boolean : containsPoint( DzVec3 point )

Parameter(s):

point - The point to check whether or not this box contains it.

Return Value:

true if point is inside this box, otherwise false.

Since:

4.9.3.48

DzVec3 : getCenter()

Return Value:

The center point of this box.

Object : getIntersection( DzLine3 ray )

Tests this box for intersection with the ray, and determines the two points on this box intersected by the line.

Parameter(s):

ray - The line to test for intersection with this box.

Return Value:

An object where the “intersects” property represents whether or not this box intersects with the given line, the “firstIntersection” property represents the first intersection point, and the “lastIntersection” property represents the last intersection point if ray intersects.

Since:

4.14.1.36

Number : getSize()

Return Value:

The corner to corner distance of this box.

DzBox3 : getTransformedBox( DzMatrix3 matrix )

Creates a new box by transforming the corners of this box through the given matrix and then including them.

Parameter(s):

matrix - The transform to apply.

Return Value:

A copy of this box that has been transformed by the matrix.

void : include( DzVec3 vec )

Parameter(s):

vec - The point to include in this box.

void : include( DzBox3 box )

Grows this box, if necessary, to include the given box.

Parameter(s):

box - The box to include in this box.

Boolean : isValid()

Return Value:

true if this box is valid, false if it is uninitialized.

Since:

4.9.3.33

Boolean : testIntersection( DzLine3 ray, Number tolerance )

Provides a fast intersection test without returning the intersection locations. This function is much faster than getIntersection().

Parameter(s):

ray - The line to test for intersection with this box.
tolerance - The amount of deviation allowed and still be considered an intersection.

Return Value:

true if the ray intersects this box, otherwise false.

Since:

4.9.3.33

String : toString()

Return Value:

A string representation of this box in the form "[[ minX, minY, minZ ],[ maxX, maxY, maxZ ]]".

void : translate( DzVec3 vec )

Translates this box by adding the given vector.

Parameter(s):

vec - The vector to translate by.

DzBoxLayout

2022-05-23T17:33:31+00:00

DzBoxLayout

Script wrapper for QBoxLayout.

More...

Inherits :

QObject
- DzLayout

Inherited By : DzHBoxLayout and DzVBoxLayout

Enumerations

DAZ Script
Direction	{ LeftToRight, RightToLeft, TopToBottom, BottomToTop }

Properties

DAZ Script
Direction	direction

Constructors

DAZ Script
DzBoxLayout ( DzWidget parent, Direction direction=LeftToRight )
DzBoxLayout ( DzLayout parent, Direction direction=LeftToRight )

Methods

DAZ Script
void	addLayout ( DzLayout item, Number stretch=0 )
void	addSpacing ( Number size )
void	addStretch ( Number stretch=0 )
void	addStrut ( Number size )
void	addWidget ( DzWidget item, Number stretch=0 )

Detailed Description

A layout that manages child items in a horizontal or vertical box.

Enumerations

: Direction

Used to determine the direction of a box layout.

LeftToRight - Horizontal from left to right.
RightToLeft - Horizontal from right to left.
TopToBottom - Vertical from top to bottom.
BottomToTop - Vertical from bottom to top.

Properties

Direction : direction

Holds the direction of the layout.

Constructors

DzBoxLayout( DzWidget parent, Direction direction=LeftToRight )

Creates a box layout that manages child items.

Parameter(s):

parent - The widget to set as the parent.
direction - The direction of the layout.

DzBoxLayout( DzLayout parent, Direction direction=LeftToRight )

Creates a box layout as a sub-layout of another layout.

Parameter(s):

parent - The layout to set as the parent.
direction - The direction of the layout.

Methods

void : addLayout( DzLayout item, Number stretch=0 )

Adds a layout to the items managed by this layout.

Parameter(s):

item - The layout to add.
stretch - The stretch factor to set.

void : addSpacing( Number size )

Adds a non-stretchable space to the end of this layout.

Parameter(s):

size - The size to set.

void : addStretch( Number stretch=0 )

Adds a stretchable space to the end of this layout.

Parameter(s):

stretch - The stretch factor to set.

void : addStrut( Number size )

Limits the minimum dimension perpendicular to the direction of this layout.

Parameter(s):

size - The size to set.

void : addWidget( DzWidget item, Number stretch=0 )

Adds a widget to the items managed by this layout.

Parameter(s):

item - The widget to add.
stretch - The stretch factor to set.

DzBrickMaterial

2022-05-24T21:42:24+00:00

DzBrickMaterial

Material that uses Shader Bricks to generate its shader.

More...

Inherits :

Static Methods

DAZ Script
DzBrickMaterial	convertDefaultMaterial ( DzDefaultMaterial mat )
DzBrickMaterial	convertUberIrayMaterial ( DzMaterial mat )

Constructors

DAZ Script
DzBrickMaterial ()

Methods

DAZ Script
Number	addBrick ( DzShaderBrick brick )
Boolean	allowsAutoBake ()
void	applyToScene ()
void	deleteAllBricks ()
void	deleteBrick ( Number id )
void	deleteBrick ( DzShaderBrick brick )
void	endEditMode ()
DzShaderBrick	getBrick ( Number id )
Array	getBrickIDs ()
DzBrickSet	getBrickSet ( Number i )
String	getBrickUserName ()
String	getExtension ()
Number	getNumBrickSets ()
void	invalidateSets ()
Boolean	isInEditMode ()
void	setBrickUserName ( String name )
void	setMaterialName ( String name )
void	setNeedsPtexParams ( Boolean onoff )
void	setNeedsTangentSpaceParams ( Boolean onoff )
void	startEditMode ()
void	updateIdentifierOnSetInvalidate ( Boolean onOff )
Boolean	usesLocalShaderSpace ()

Signals

void	brickAdded ( DzShaderBrick brick )
void	brickRemoved ( DzShaderBrick brick )
void	generateFilesFinished ()
void	generateFilesStarted ()

Detailed Description

TODO: Add detailed description.

Static Methods

DzBrickMaterial : convertDefaultMaterial( DzDefaultMaterial mat )

Converts the given default material to a brick material.

Parameter(s):

mat - The material to be converted.

DzBrickMaterial : convertUberIrayMaterial( DzMaterial mat )

Converts the given Uber Iray material to a brick material.

Parameter(s):

mat - The material to be converted.

Constructors

DzBrickMaterial()

Creates a new brick material.

Methods

Number : addBrick( DzShaderBrick brick )

Adds the given brick to this brick material.

Parameter(s):

brick - The brick to add.

Return Value:

The id of the added brick.

Boolean : allowsAutoBake()

Return Value:

true if this brick material allows auto-baking, otherwise false.

void : applyToScene()

Apply a copy of this material to all selected materials in the scene.

void : deleteAllBricks()

Deletes all bricks in this material.

void : deleteBrick( Number id )

Deletes the brick with the given id from the material.

Parameter(s):

id - The id of the brick to delete.

void : deleteBrick( DzShaderBrick brick )

Deletes the given brick from the material.

Parameter(s):

brick - The brick to delete.

void : endEditMode()

Takes this brick material out of edit mode.

DzShaderBrick : getBrick( Number id )

Parameter(s):

id - The id of the desired brick.

Return Value:

The brick at the given id.

Array : getBrickIDs()

Return Value:

A list of the ids for the bricks associated with this brick material.

DzBrickSet : getBrickSet( Number i )

Parameter(s):

i - The index of the desired brick set.

Return Value:

The brick set at the specified location.

String : getBrickUserName()

Return Value:

The user name of this brick material.

String : getExtension()

Return Value:

The extension for this brick material.

Number : getNumBrickSets()

Return Value:

The number of brick sets in this brick material.

void : invalidateSets()

Invalidates the brick sets, causing them to be rebuilt.

Boolean : isInEditMode()

Return Value:

true if this brick material is currently in edit mode, otherwise false.

void : setBrickUserName( String name )

Sets the user name of this brick material.

Parameter(s):

name - The new name for this brick material.

void : setMaterialName( String name )

Sets the name for this brick material.

Parameter(s):

name - The new name to be used.

void : setNeedsPtexParams( Boolean onoff )

Sets whether or not this brick material needs Ptex parameters.

Parameter(s):

onoff - If true, this brick material needs Ptex parameters.

void : setNeedsTangentSpaceParams( Boolean onoff )

Sets whether this brick material needs tangent space parameters.

Parameter(s):

onoff - If true, this brick material will need tangent space parameters.

void : startEditMode()

Puts this brick material in edit mode.

void : updateIdentifierOnSetInvalidate( Boolean onOff )

Sets whether the identifier is updated when this brick material is invalidated.

Parameter(s):

onOff - If true, the identifier will be updated when this brick material is invalidated.

Boolean : usesLocalShaderSpace()

Return Value:

true if this brick material uses local shader space.

Signals

void : brickAdded( DzShaderBrick brick )

Signature:“brickAdded(DzShaderBrick*)”

Emitted when a brick is added to this brick material.

Parameter(s):

brick - The brick that was added.

void : brickRemoved( DzShaderBrick brick )

Signature:“brickRemoved(DzShaderBrick*)”

Emitted when a brick is removed from this brick material.

Parameter(s):

brick - The brick that was removed.

void : generateFilesFinished()

Emitted when file generation is finished.

void : generateFilesStarted()

Emitted when file generation is started.

DzBrickSet

2022-10-19T03:23:49+00:00

DzBrickSet

Base class for a set of bricks that form a single shader.

More...

Inherits :

Enumerations

Methods

DAZ Script
String	getFullShaderPath ()
String	getShaderFile ()
void	invalidateFiles ()
void	sendForUpdate ()

Detailed Description

This class holds a root brick and handles tracing that root brick through its children to form a RSL and/or MDL shader. A root brick is any brick that does not have a DzBrickSet::ShaderType of NONE.

See Also:

DzShaderBrick

Enumerations

Methods

String : getFullShaderPath()

Return Value:

The absolute shader path for the generated shader.

String : getShaderFile()

Return Value:

The destination of the shader file this set will create.

void : invalidateFiles()

Invalidates the files generated by this set.

void : sendForUpdate()

Queues this brick set to be recompiled if necessary.

DzButton

2022-05-24T21:41:10+00:00

DzButton

DAZScript abstract base class for button widgets.

More...

Inherits :

QObject
- DzWidget

Inherited By : DzCheckBox, DzPushButton and DzRadioButton

Enumerations

Deprecated
ToggleState	{ Off, NoChange, On }
ToggleType	{ SingleShot, Toggle, Tristate }

Properties

DAZ Script
Boolean	autoRepeat
Number	autoRepeatDelay
Number	autoRepeatInterval
Boolean	checkable
Boolean	checked
Boolean	down
Pixmap	pixmap
String	text
Boolean	toggleButton
Deprecated
Boolean	exclusiveToggle
Boolean	on
ToggleState	toggleState
ToggleType	toggleType

Methods

DAZ Script
void	toggle ()

Signals

void	clicked ()
void	pressed ()
void	released ()
void	stateChanged ( Number state )
void	toggled ( Boolean onOff )

Detailed Description

DzButton implements an abstract button base. Subclasses specify how to respond to user interaction, and how to present the button to the user. If you want to create a button, create a DzPushButton.

DzPushButton provides both push and toggle buttons. The DzRadioButton and DzCheckBox classes provide only toggle buttons.

The difference between down and on is, when a user clicks a [toggle] button to toggle it on, the button is first pressed and then released into the On state (on is true, down is false). When the user clicks it again (to toggle it off), the button is first pressed and then released to the Off state (on and down are false).

Enumerations

: ToggleState

Deprecated

This is no longer applicable. See DzCheckBox::tristate and DzCheckBox::checked

: ToggleType

Deprecated

This is no longer applicable. See DzCheckBox::tristate

Properties

Boolean : autoRepeat

Holds whether or not autoRepeat is enabled. false by default. If enabled, the clicked() signal is emitted at regular intervals if down is true. This property has no effect on toggle buttons.

Number : autoRepeatDelay

Holds the initial delay, in milliseconds, before auto-repetition begins

Number : autoRepeatInterval

Holds the length of the auto-repetition interval, in milliseconds

Boolean : checkable

Holds whether or not the button is checkable. false by default.

Boolean : checked

Holds whether or not the button is checked. Only applies to checkable buttons.

Boolean : down

Holds whether or not the button is pressed. true if the button is pressed down. false by default. The signals pressed() and clicked() are not emitted when this property set to true.

Pixmap : pixmap

Holds the Pixmap shown on the button. If the Pixmap is monochrome (e.g. its depth is 1) and it does not have a mask, the Pixmap will be its own mask. This allows transparent bitmaps to be drawn, which are important for toggle buttons. 0 if no pixmap is set.

String : text

Holds the text displayed on the button. undefined by default. An ampersand (&) in the String automatically creates an accelerator for it using the character that follows the ampersand, as the accelerator key. Any previous accelerator will be overwritten, or cleared if no accelerator is defined by the text.

Boolean : toggleButton

Holds whether or not the button is a toggle (Read Only). false by default.

Boolean : exclusiveToggle

Deprecated

Exists only to keep old code working. Do not use in new code. This is always false.

Boolean : on

Deprecated

Exists only to keep old code working. Do not use in new code. This is always false.

ToggleState : toggleState

Deprecated

Exists only to keep old code working. Do not use in new code. This is always NoChange.

See Also:

DzCheckBox::checkState

ToggleType : toggleType

Deprecated

Exists only to keep old code working. Do not use in new code. This is always SingleShot.

See Also:

DzCheckBox::tristate

Methods

void : toggle()

Toggles the state of a toggle button.

Signals

void : clicked()

Signature:“clicked()”

Emitted when the button is pressed and then released.

void : pressed()

Signature:“pressed()”

Emitted when the button is pressed.

void : released()

Signature:“released()”

Emitted when the button is released.

void : stateChanged( Number state )

Signature:“stateChanged(int)”

Emitted when toggleState on this button has changed.

void : toggled( Boolean onOff )

Signature:“toggled(bool)”

Emitted when the button is toggled.

Parameter(s):

onOff - true if the button is on, false if the button is off.

DzButtonGroup

2022-05-24T21:41:15+00:00

DzButtonGroup

Script wrapper for QButtonGroup.

More...

Inherits :

QObject
- DzWidget
  - DzGroupBox

Inherited By : DzHButtonGroup (deprecated) and DzVButtonGroup (deprecated)

Properties

DAZ Script
Number	count
Boolean	exclusive
Boolean	radioButtonExclusive
Number	selected

Constructors

DAZ Script
DzButtonGroup ( DzWidget parent )

Methods

DAZ Script
void	addButton ( DzButton button )
void	addButton ( DzButton button, Number id )
DzButton	button ( Number id )
Array	buttons ()
DzButton	checkedButton ()
Number	id ( DzButton button )
Number	insert ( DzButton button, Number id=-1 )
void	removeButton ( DzButton button )
Deprecated
void	remove ( DzButton button )

Signals

void	clicked ( Number id )
void	pressed ( Number id )
void	released ( Number id )

Detailed Description

Provides an abstract container that manages the states of DzButton instances placed within it - it does not provide a visual representation.

See Also:

DzGroupBox

Properties

Number : count

Holds the number of buttons in this group (Read Only)

Boolean : exclusive

Holds whether or not this group is exclusive for all toggle buttons (the default is false)

Boolean : radioButtonExclusive

Holds whether or not this group is exclusive for radio buttons (the default is true)

Number : selected

Holds the checked button in an exclusive group

Constructors

DzButtonGroup( DzWidget parent )

Creates a button group as a child of the given parent widget

Methods

void : addButton( DzButton button )

Adds the specified button to this group. This is only necessary if the button was not created as a child of the group.

Parameter(s):

button - The button to add.

void : addButton( DzButton button, Number id )

Adds the specified button to this group with the specified id. This is only necessary if the button was not created as a child of the group.

Parameter(s):

button - The button to add.
id - The id to assign.

DzButton : button( Number id )

Parameter(s):

id - The id of the button to get.

Return Value:

The button in this group with the specified id (if any), otherwise null.

Since:

4.15.0.21

Array : buttons()

Return Value:

A list of the buttons in this group.

DzButton : checkedButton()

Return Value:

The button that is currently checked (selected) in this group.

Since:

4.15.0.21

Number : id( DzButton button )

Parameter(s):

button - The button to get the id of.

Return Value:

The id of the specified button (if any), otherwise -1.

Number : insert( DzButton button, Number id=-1 )

Inserts the specified button into this group, with the specified id. This is only necessary if the button was not created as a child of the group.

Parameter(s):

button - The button to insert.
id - The id to assign.

Return Value:

The id of button in the group.

void : removeButton( DzButton button )

Removes the specified button from this group.

Parameter(s):

button - The button to remove.

void : remove( DzButton button )

Deprecated

Exists only to keep old code working. Do not use in new code. Use removeButton() instead.

Signals

void : clicked( Number id )

Signature:“clicked(int)”

Emitted when a button in the group is pressed and released

void : pressed( Number id )

Signature:“pressed(int)”

Emitted when a button in the group is pressed

void : released( Number id )

Signature:“released(int)”

Emitted when a button in the group is released

DzBvhExporter

2022-05-26T07:20:29+00:00

DzBvhExporter

Class for exporting animation data to the BioVision Hierarchy (*.bvh) format.

More...

Inherits :

QObject
- DzBase
  - DzFileIO
    - DzExporter

Constructors

DAZ Script
DzBvhExporter ()

Detailed Description

See Also:

Constructors

DzBvhExporter()

Default Constructor.

DzBvhImporter

2022-05-26T07:20:47+00:00

DzBvhImporter

Class for importing animation data from the BioVision Hierarchy (*.bvh) format.

More...

Inherits :

QObject
- DzBase
  - DzFileIO
    - DzImporter

Constructors

DAZ Script
DzBvhImporter ()

Detailed Description

See Also:

Constructors

DzBvhImporter()

Default Constructor.

ByteArray

2024-11-11T02:31:57+00:00

ByteArray

Script wrapper for QByteArray.

More...

Inherits :

QObject

Properties

DAZ Script
Number	length
Number	size

Constructors

DAZ Script
ByteArray ()
ByteArray ( ByteArray byteArray )
ByteArray ( String str )

Methods

DAZ Script
Number	byteAt ( Number index )
String	charAt ( Number index )
String	convertToString ()
String	convertToStringFromUtf16 ()
String	convertToStringFromUtf8 ()
ByteArray	fromBase64 ( ByteArray base64 )
ByteArray	fromHex ( ByteArray hexEncoded )
ByteArray	fromPercentEncoding ( ByteArray pctEncoded )
ByteArray	toBase64 ()
ByteArray	toHex ()
ByteArray	toPercentEncoding ( ByteArray exclude=ByteArray, ByteArray include=ByteArray )

Detailed Description

This is the script counterpart to the QByteArray type used in the C++ SDK.

Attention:

Inheritance will change to Object in a pending update.

Properties

Number : length

The number of bytes in the array

Number : size

The number of bytes in the array

Constructors

ByteArray()

Default Constructor.

ByteArray( ByteArray byteArray )

Copy Constructor.

Parameter(s):

byteArray - The ByteArray to copy.

ByteArray( String str )

Creates a byte array containing the ascii representation of the string.

Parameter(s):

str - The string to copy into the byte array.

Methods

Number : byteAt( Number index )

Parameter(s):

index - The index of the byte to return.

Return Value:

The byte at the given index in the array of bytes.

String : charAt( Number index )

Parameter(s):

index - The index of the byte to return.

Return Value:

The character at the given index in the array of bytes.

String : convertToString()

Return Value:

The array of bytes as a string.

String : convertToStringFromUtf16()

Return Value:

The array of bytes as a string.

String : convertToStringFromUtf8()

Return Value:

The array of bytes as a string.

ByteArray : fromBase64( ByteArray base64 )

Return Value:

A decoded copy of the Base64 encoded array base64.

Attention:

Input is not checked for validity; invalid characters in the input are skipped, enabling the decoding process to continue with subsequent characters.

Since:

4.10.0.88

ByteArray : fromHex( ByteArray hexEncoded )

Return Value:

A decoded copy of the hexidecimal encoded array hexEncoded.

Attention:

Input is not checked for validity; invalid characters in the input are skipped, enabling the decoding process to continue with subsequent characters.

Since:

4.10.0.88

ByteArray : fromPercentEncoding( ByteArray pctEncoded )

Return Value:

A decoded copy of the URI/URL-style percent-encoded pctEncoded.

Since:

4.10.0.88

ByteArray : toBase64()

Return Value:

A copy of the byte array, encoded as Base64.

Attention:

The algorithm used to encode Base64-encoded data is defined in RFC 2045.

Since:

4.10.0.88

ByteArray : toHex()

Return Value:

A hexidecimal encoded copy of the byte array.

Attention:

Hexidecimal encoding uses the numbers 0-9 and the letters a-f.

Since:

4.10.0.88

ByteArray : toPercentEncoding( ByteArray exclude=ByteArray, ByteArray include=ByteArray )

Parameter(s):

exclude - To characters to prevent from being encoded.
exclude - To characters to force being encoded.

Return Value:

A URI/URL-style percent-encoded copy of this byte array.

Attention:

By default, this function will encode all characters that are not one of the following: ALPHA (“a” to “z” and “A” to “Z”) / DIGIT (0 to 9) / “-” / “.” / “_” / “~”

Since:

4.10.0.88

DzCallBack

2022-05-23T17:35:39+00:00

DzCallBack

DAZ Script callback object.

More...

Inherits :

QObject

Methods

DAZ Script
void	addToGroup ( String group )
void	clearConnection ()
void	clearScriptFunction ()
Object	getArg ( Number i )
Number	getArgCount ()
Boolean	getBlockedDuringSceneLoad ()
Boolean	getDeleteAfterExecution ()
QVariant	getDynamicProperty ( String name )
Array	getGroups ()
Boolean	getProcessAsEvent ()
String	getScript ()
QObject	getSender ()
Boolean	isEvaluated ()
void	removeFromGroup ( String group )
void	setBlockedDuringSceneLoad ( Boolean onOff )
Boolean	setConnection ( QObject sender, String signal )
Boolean	setConnection ( QObject sender, String signal, Boolean garbageCollect )
Number	setConnections ( QObject sender, Array signalList, Boolean garbageCollect )
void	setDeleteAfterExecution ( Boolean onOff )
void	setDynamicProperty ( String name, QVariant value )
void	setProcessAsEvent ( Boolean onOff )
void	setScript ( String script, Boolean evaluate )
void	setScriptFunction ( Function functionRef, Object thisObject )
void	setScriptFunction ( Function functionRef )

Detailed Description

Encapsulates an object that is used to execute a script when a signal that it is connected to is triggered.

See Also:

DzCallBackMgr::createCallBack()
DzCallBackMgr::getCallBack()

Methods

void : addToGroup( String group )

Adds the callback to the given callback group.

Parameter(s):

group - The name of the group to add the callback to.

void : clearConnection()

Disconnects from the signal that triggers this callback.

void : clearScriptFunction()

Clears the script Function assigned to this callback.

Since:

4.11.0.270

Object : getArg( Number i )

Return Value:

The i'th argument from the current execution of the callback.

Attention:

Callbacks that are processed as events or blocked during scene load are provided no arguments and getSender() always returns the first QObject connected to, which is not necessarily the one sending the signal.

See Also:

setProcessAsEvent()
setBlockedDuringSceneLoad()

Number : getArgCount()

Return Value:

The number of arguments for the current execution of the callback.

Attention:

Callbacks that are processed as events or blocked during scene load are provided no arguments and getSender() always returns the first QObject connected to, which is not necessarily the one sending the signal.

See Also:

setProcessAsEvent()
setBlockedDuringSceneLoad()

Boolean : getBlockedDuringSceneLoad()

Return Value:

true if this callback is not processed during a scene load but is instead processed at the end of a scene load, otherwise false.

Boolean : getDeleteAfterExecution()

Return Value:

true if this callback is set to be deleted after it has been executed, otherwise false.

Since:

4.6.4.67

QVariant : getDynamicProperty( String name )

Parameter(s):

name - The name of the property to retrieve the value of.

Return Value:

The value of the dynamic property (if any).

Since:

4.9.4.90

Array : getGroups()

Return Value:

A list of the groups that this callback belongs to.

Boolean : getProcessAsEvent()

Return Value:

true if this callback is processed as an event, otherwise false.

String : getScript()

Return Value:

The script that is executed when the signal is emitted.

QObject : getSender()

Return Value:

The object that sent the signal, or NULL.

Boolean : isEvaluated()

Return Value:

true if getScript() for this callback is the actual code that gets executed, false if getScript() contains the filename of the script to execute.

void : removeFromGroup( String group )

Removes this callback from the group callback group.

Parameter(s):

group - The name of the group to remove the callback from.

void : setBlockedDuringSceneLoad( Boolean onOff )

Parameter(s):

onOff - If true, this callback will not be processed while the scene is loading, it will be processed when the scene is finished loading.

Attention:

Callbacks that are blocked during scene load are provided no arguments and getSender() always returns the first QObject connected to, which is not necessarily the one sending the signal.

Boolean : setConnection( QObject sender, String signal )

Makes the connection that triggers this callback.

Parameter(s):

sender - The object that the signal belongs to.
signal - The signature of the signal to connect to.

Boolean : setConnection( QObject sender, String signal, Boolean garbageCollect )

Makes the connection that triggers this callback.

Parameter(s):

sender - The object that the signal belongs to.
signal - The signature of the signal to connect to.
garbageCollect - If true, remove this callback from the DzCallBackMgr when sender is deleted.

Number : setConnections( QObject sender, Array signalList, Boolean garbageCollect )

Makes the connection that triggers this callback.

Parameter(s):

sender - The object that the signal belongs to.
signalList - List of signal signatures to connect to.
garbageCollect - If true, remove this callback from the DzCallBackMgr when sender is deleted.

Return Value:

The number of connections in signalList that are established, or -1 if sender is null.

void : setDeleteAfterExecution( Boolean onOff )

Parameter(s):

onOff - If true, sets this callback to be deleted after it has been executed.

Since:

4.6.4.67

void : setDynamicProperty( String name, QVariant value )

Sets a dynamic property on this callback.

Parameter(s):

name - The name of the property to set.
value - The value to set.

Attention:

value can be any value of the type Array, Boolean, ByteArray, Color, Date, DateTime, Font, Image, Number, Object, Palette, Pixmap, Point, Rect, RegExp, Size, String, Time, and many other QObject derivatives. Setting value to null or undefined removes the dynamic property.

Since:

4.9.4.90

void : setProcessAsEvent( Boolean onOff )

Parameter(s):

onOff - If true, sets this callback to trigger as it is encountered in the event stack.

Attention:

Callbacks that are processed as events are provided no arguments and getSender() always returns the first QObject connected to, which is not necessarily the one sending the signal.

void : setScript( String script, Boolean evaluate )

Sets the script that will be executed by this callback.

Parameter(s):

script - The filename or code of the script to execute.
evaluate - If script is the actual code and it should be embedded, set this to true, otherwise it is assumed that script is the path of a script file to execute.

void : setScriptFunction( Function functionRef, Object thisObject )

Connects this callback to a script Function.

Parameter(s):

functionRef - The script Function to call.
thisObject - The object to bind to 'this' in the scope of functionRef.

Since:

4.11.0.270

void : setScriptFunction( Function functionRef )

Connects this callback to a script Function.

Parameter(s):

functionRef - The script Function to call.

Since:

4.11.0.270

DzCallBackMgr

2021-07-10T07:45:39+00:00

DzCallBackMgr

Manager responsible for handling callback objects.

More...

Inherits :

QObject

Methods

DAZ Script
void	clearAllCallBacks ()
DzCallBack	createCallBack ( String name, String script, Boolean evaluate )
DzCallBack	createCallBack ( String name )
void	deleteCallBack ( Number index )
void	deleteCallBack ( String name )
void	deleteCallBack ( DzCallBack callBack )
void	deleteCallBackGroup ( String name )
DzCallBack	getCallBack ( Number index )
DzCallBack	getCallBack ( String name )
Number	getCallBackIndex ( String name )
Array	getCallBackList ()
Array	getGroup ( String name )
Number	getNumCallBacks ()
Array	getSignalSignature ( QObject obj, String signalName=“” )

Detailed Description

Responsible for the management of objects that are used to execute a script when a signal that the object is connected to is emitted.

There is only one instance of this manager in an application. This instance is created and owned by DzApp. Request the instance via DzApp::getCallBackMgr().

Example:

Dynamically load a script.

var sScript = "support/CallBackExample/HelloWorld.dsa";
var oCallBackMgr = App.getCallBackMgr();
var oCallBack = oCallBackMgr.createCallBack( "Hello World", sScript, false );
 
oCallBack.setConnection( Scene, "nodeAdded(DzNode*)" );

Example:

Embed a script.

var sPath = String( "%1/support/CallBackExample/HelloWorld.dsa" ).arg( App.getScriptsPath() );
var oScript = new DzScript;
oScript.loadFromFile( sPath );
var sScript = oScript.getCode();
 
var oCallBackMgr = App.getCallBackMgr();
var oCallBack = oCallBackMgr.createCallBack( "Hello World", sScript, true );
 
oCallBack.setConnection( Scene, "nodeAdded(DzNode*)" );

Example:

CallBack script (./support/CallBackExample/HelloWorld.dsa).

“CallBack” is a global transient variable referring to the DzCallBack that executes the script.

var oSender = CallBack.getSender();
var sMessage = String( "Sender Class: %1\n" +
		"Sender Name: %2\n\n" +
		"CallBack Args: %3" )
		.arg( oSender.className() )
		.arg( oSender.name )
		.arg( CallBack.getArgCount() );
 
var nArgs = CallBack.getArgCount();
if( nArgs > 0 ){
	for( var i = 0; i < nArgs; i += 1 ){
		sMessage += String( "\nArg %1 : %2" ).arg( i ).arg( CallBack.getArg( i ) );
	}
}
 
MessageBox.information( sMessage, CallBack.className(), "&OK" );

See Also:

Global::App
Samples: Post-Load Callbacks

Methods

void : clearAllCallBacks()

Deletes all callbacks.

DzCallBack : createCallBack( String name, String script, Boolean evaluate )

Creates a DzCallBack object.

Parameter(s):

name - The name for the callback.
script - The filename or code of the script to execute.
evaluate - If script is the actual code and it should be embedded, set this to true, otherwise it is assumed that script is the path of a script file to execute.

DzCallBack : createCallBack( String name )

Creates a DzCallBack object.

Parameter(s):

name - The name for the callback.

void : deleteCallBack( Number index )

Deletes the callback at the given index.

Parameter(s):

index - The index of the callback to delete.

void : deleteCallBack( String name )

Deletes all callbacks with the given name.

Parameter(s):

name - The name of the callback to delete.

void : deleteCallBack( DzCallBack callBack )

Deletes the specified callback.

Parameter(s):

callBack - The callback to delete.

void : deleteCallBackGroup( String name )

Deletes all callbacks in a given group.

Parameter(s):

name - The name of the group with callbacks to delete.

DzCallBack : getCallBack( Number index )

Return Value:

The callback at index if at least one callback exists and index is within the range [0, getNumCallBacks() - 1], otherwise null.

DzCallBack : getCallBack( String name )

Return Value:

The first DzCallBack object with the given name.

Number : getCallBackIndex( String name )

Return Value:

The index of the first callback named name.

Array : getCallBackList()

Return Value:

The list of all callbacks.

Array : getGroup( String name )

Return Value:

The list of callbacks in the group named name.

Number : getNumCallBacks()

Return Value:

The number of callbacks.

Array : getSignalSignature( QObject obj, String signalName=“” )

Return Value:

A list of strings that represent the signature(s) of the signal with the specified name.

DzCamera

2024-11-11T00:41:26+00:00

DzCamera

Base class for all camera objects.

More...

Inherits :

QObject
- DzBase
  - DzElement
    - DzNode

Inherited By : DzBasicCamera and DzLight

Enumerations

DAZ Script
CameraDimension	{ LOCAL_PIXEL_WIDTH, LOCAL_PIXEL_HEIGHT, LOCAL_ASPECT_WIDTH, LOCAL_ASPECT_HEIGHT }
CameraType	{ FRONT_CAMERA, BACK_CAMERA, LEFT_CAMERA, RIGHT_CAMERA, TOP_CAMERA, BOTTOM_CAMERA, PERSPECTIVE_CAMERA, ORTHO_CAMERA, GENERAL_CAMERA }
HeadlightMode	{ hmAuto, hmOn, hmOff }

Properties

DAZ Script
Number	aspectHeight
Number	aspectRatio
Number	aspectWidth
Number	farClippingPlane
Number	focalDistance
Number	focalLength
Number	frameWidth
HeadlightMode	headlightMode
DzVec3	headlightOffset
Number	nearClippingPlane
Number	pixelsHeight
Number	pixelsWidth
Boolean	proportionsConstrained
Number	type
Boolean	useLocalDimensions

Methods

DAZ Script
void	aimAt ( DzVec3 pos )
void	frame ( DzBox3 box, Number aspect )
Number	getFieldOfView ()
DzVec3	getFocalPoint ()
DzLight	getHeadlight ()
Boolean	isViewCamera ()
void	reset ()
Boolean	shouldDoHeadLight ( Boolean hasLights, Boolean isRender )
void	updateDimensions ( CameraDimension anchor )

Signals

void	aspectHeightChanged ( Number height )
void	aspectRatioChanged ()
void	aspectWidthChanged ( Number width )
void	dimensionsChanged ()
void	focalDistanceChanged ( DzTimeRange range )
void	focalLengthChanged ( DzTimeRange range )
void	frameWidthChanged ( Number size )
void	headlightModeChanged ()
void	headlightOffsetChanged ()
void	pixelDimensionsChanged ()
void	pixelsHeightChanged ( Number height )
void	pixelsWidthChanged ( Number width )
void	projectionChanged ()
void	proportionsConstrainedChanged ( Boolean yesNo )
void	useLocalDimensionsChanged ( Boolean yesNo )

Detailed Description

TODO: Add detailed description.

Enumerations

: CameraDimension

The dimensions of a camera.

Since:

4.6.4.70

LOCAL_PIXEL_WIDTH - The width in pixels. Since: 4.6.4.70
LOCAL_PIXEL_HEIGHT - The height in pixels. Since: 4.6.4.70
LOCAL_ASPECT_WIDTH - The relative width of the aspect frame. Since: 4.6.4.70
LOCAL_ASPECT_HEIGHT - The relative height of the aspect frame. Since: 4.6.4.70

—–

: CameraType

The different types of camera. Each has its own default parameters which it resets to and are either orthogonal or perspective by definition.

FRONT_CAMERA - Orthogonal camera positioned to view the front of a figure
BACK_CAMERA - Orthogonal camera positioned to view the back of a figure
LEFT_CAMERA - Orthogonal camera positioned to view the left side of a figure.
RIGHT_CAMERA - Orthogonal camera positioned to view the right side of a figure.
TOP_CAMERA - Orthogonal camera positioned to view a figure from the top.
BOTTOM_CAMERA - Orthogonal camera positioned to view a figure from the bottom.
PERSPECTIVE_CAMERA - Default perspective camera - defaults to a front view of a figure.
ORTHO_CAMERA - General Orthogonal camera.
GENERAL_CAMERA - General Perspective camera.

—–

: HeadlightMode

The modes of the headlight for this camera.

Since:

4.7.1.94

hmAuto - The headlight is automatically on or off depending on whether or not lights are in the scene. Since: 4.7.1.94
hmOn - The headlight is on. Since: 4.7.1.94
hmOff - The headlight is off. Since: 4.7.1.94

Properties

Number : aspectHeight

Holds the aspect height of this camera.

Since:

4.6.4.67

Number : aspectRatio

Holds the aspect ratio of this camera (w / h).

See Also:

DzRenderOptions::aspect.

Since:

4.6.4.67

Number : aspectWidth

Holds the aspect width of this camera.

Since:

4.6.4.67

Number : farClippingPlane

Holds the distance of the far clipping plane from this camera. (Read Only)

Number : focalDistance

Holds the focal distance of this camera.

Number : focalLength

Holds the focal length of this camera.

Number : frameWidth

Holds the width of the frame (film/sensor) of this camera (in mm). (Read Only)

Since:

4.6.4.67

HeadlightMode : headlightMode

Holds the mode of the headlight.

Since:

4.7.1.94

DzVec3 : headlightOffset

Holds the relative offset of the headlight from this camera.

Since:

4.7.1.94

Number : nearClippingPlane

Holds the distance of the near clipping plane from this camera. (Read Only)

Number : pixelsHeight

Holds the pixels height of this camera.

Since:

4.6.4.67

Number : pixelsWidth

Holds the pixels width of this camera.

Since:

4.6.4.67

Boolean : proportionsConstrained

Holds whether or not the proportions of this camera is constrained.

Since:

4.6.4.70

Number : type

Holds the type of this camera. (Read Only)

Boolean : useLocalDimensions

Holds whether or not to use the local dimensions of this camera.

Since:

4.6.4.67

Methods

void : aimAt( DzVec3 pos )

Rotates this camera and adjusts its focal distance so that its focal point is at the given point.

Parameter(s):

pos - The point to aim this camera at.

void : frame( DzBox3 box, Number aspect )

Translates this camera so that its view frames the given box, and sets this camera's focal point to the center of the box, given the aspect ratio of the current view (w / h)

Parameter(s):

box - The bounding box to frame in this camera's view
aspect - The aspect ratio of the current view.

Number : getFieldOfView()

Return Value:

The angle, in radians, of the horizontal field of view (FOV) for this camera (rectilinear lens).

Attention:

The following formula is used to calculate the horizontal FOV:

angle = 2 * (arctan(frameWidth)/(2 * focalLength))

The aspect of the frame can be manipulated by the user. Therefore, calculating the vertical and/or diagonal FOV is accomplished using the aspect ratio.

See Also:

aspectRatio

DzVec3 : getFocalPoint()

Return Value:

The focal point of this camera.

DzLight : getHeadlight()

Return Value:

A light that illuminates the scene in front of this camera. Used for rendering by OpenGL and offline renderers when no lights exist in the scene. This headlight is created on demand - i.e. no headlight for this camera exists until this function is called the first time.

Boolean : isViewCamera()

Return Value:

true if this is a non-animatable view camera, otherwise false.

void : reset()

Resets this camera viewing parameters to defaults.

Boolean : shouldDoHeadLight( Boolean hasLights, Boolean isRender )

Parameter(s):

hasLights - Whether or not the scene has lights.
isRender - Whether or not the call is for the purpose of a render.

Return Value:

true if the headlight should contribute light to the scene, otherwise false.

Since:

4.7.1.94

void : updateDimensions( CameraDimension anchor )

Updates the other dimensions given an anchor dimension.

Parameter(s):

anchor - The anchor dimension.

Signals

void : aspectHeightChanged( Number height )

Signature:“aspectHeightChanged(float)”

Emitted when the aspect height dimension of this camera changes.

void : aspectRatioChanged()

Signature:“aspectRatioChanged()”

Emitted when this camera's aspect ratio changes.

void : aspectWidthChanged( Number width )

Signature:“aspectWidthChanged(float)”

Emitted when the aspect width dimension of this camera changes.

void : dimensionsChanged()

Signature:“dimensionsChanged()”

Emitted when any of the local dimensions of this camera change.

void : focalDistanceChanged( DzTimeRange range )

Signature:“focalDistanceChanged(const DzTimeRange&)”

Emitted when the focal distance channel changes.

Parameter(s):

range - The time range over which the channel changed.

void : focalLengthChanged( DzTimeRange range )

Signature:“focalLengthChanged(const DzTimeRange&)”

Emitted when the focal length channel changes.

Parameter(s):

range - The time range over which the channel changed.

void : frameWidthChanged( Number size )

Signature:“frameWidthChanged(float)”

Emitted when the frame width of this camera changes.

void : headlightModeChanged()

Signature:“headlightModeChanged()”

Emitted when headlight mode of this camera changes.

void : headlightOffsetChanged()

Signature:“headlightOffsetChanged()”

Emitted when headlight offset of this camera changes.

void : pixelDimensionsChanged()

Signature:“pixelDimensionsChanged()”

Emitted when the local pixel dimensions of this camera change.

void : pixelsHeightChanged( Number height )

Signature:“pixelsHeightChanged(int)”

Emitted when the pixel height dimension of this camera changes.

void : pixelsWidthChanged( Number width )

Signature:“pixelsWidthChanged(int)”

Emitted when the pixel width dimension of this camera changes.

void : projectionChanged()

Signature:“projectionChanged()”

Emitted when projection of this camera changes and its view must be redrawn.

void : proportionsConstrainedChanged( Boolean yesNo )

Signature:“proportionsConstrainedChanged(bool)”

Emitted when the option for whether or not to constrain proportions of the local dimensions of this camera changes.

void : useLocalDimensionsChanged( Boolean yesNo )

Signature:“aspectRatioChanged(bool)”

Emitted when the option for whether or not to use the local dimensions of this camera changes.

DzCameraAssetFilter

2017-09-11T05:02:20+00:00

DzCameraAssetFilter

Class for saving DSON-based Camera(s) Presets.

More...

Inherits :

QObject
- DzBase
  - DzFileIO
    - DzAssetIOFilter
      - DzAssetFileOutFilter

Constructors

DAZ Script
DzCameraAssetFilter ()

Detailed Description

An asset save filter for saving a Camera(s) Preset in the DSON format.

See Also:

Sample: Save a Camera(s) Preset

Constructors

DzCameraAssetFilter()

TODO: Add description.

DzCategoryAssetContainer

2021-07-06T20:51:33+00:00

DzCategoryAssetContainer

A container type for assets that are assigned a particular classification.

More...

Inherits :

Properties

DAZ Script
Boolean	isVendor

Methods

DAZ Script
Array	getAssetsInCategory ( Boolean userFacing=true, Boolean installed=true )
String	getPath ()
void	updateRow ()

Detailed Description

A “Category” is described as a class or collection of entities regarded as having common traits and/or characteristics. Within a given class or collection of entities, certain traits and/or characteristics may be regarded as being shared by a smaller subset - i.e., a “Sub-Category.” Thus, categorization naturally supports a hierarchical structure.

The “Category” container type serves to provide a means of working with “Assets” that share characteristics without the encumbrances imposed by moving the actual files they represent on disk - moving or renaming files on disk breaks the correlation between the file and the “Asset” that represents it.

See Also:

DzAssetMgr::getCategories()
DzAsset

Properties

Boolean : isVendor

Holds whether this category is owned by a vendor or by the user. (Read Only)

Since:

4.9.3.110

Methods

Array : getAssetsInCategory( Boolean userFacing=true, Boolean installed=true )

Parameter(s):

userFacing - Whether or not to limit the list to user-facing assets.
installed - Whether or not to limit the list to installed assets.

Return Value:

A list of assets associated with the path of this container, matching the criteria specified.

See Also:

Since:

4.9.3.56

String : getPath()

Return Value:

The full path of the category that this container represents.

Since:

4.9.2.48

void : updateRow()

Updates the container using the data that is currently stored in the database.