Attribute3dEffectDepth

Applies a level of depth to a 3D effect, or retrieves the current depth setting.

This function applies to the selected object, which is typically the last placed object. By using the PageSelectFirstObject and PageSelectNextObject functions, you can access your objects and change or read their properties.

Syntax

Attribute3dEffectDepth(EffectDepth)

EffectDepth:

A value between 0 and 32 representing the depth of the 3D effect used.

Return Value

If retrieving the current depth setting for a 3D effect, a value between 0 and 32. If applying depth to a 3D effect, 0 (zero) if successful. In both cases, an error is returned if unsuccessful. If values are out of range on writing to the attribute, the function will exit and report the error E_INVALIDARG. If there is no active object, they will exit with a return value of E_HANDLE.

Note: For details on handling return and error values, see Error Handling.

Related Functions

Attribute3dEffects, AttributeShadowColour, AttributeHiLightColour, AttributeLoLightColour

Example

' Applies depth to a 3D effect for the current object
GraphicsBuilder.Attribute3dEffectDepth = 28

' Retrieves the 3D depth for the current object
MyVariable = GraphicsBuilder.Attribute3dEffectDepth

Note: This function is implemented in the C++ environment as two separate functions: put_Attribute3dEffectDepth applies depth to 3D effect, and get_Attribute3dEffectDepth retrieves the current 3D depth setting.