Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Plant SCADA

Attribute3dEffects

  • Last UpdatedJul 13, 2023
  • 1 minute read

Applies a 3D effect to an object, or retrieves the current 3D effect 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

Attribute3dEffects(Effects)

Effects:

A value between 0 and 4 representing the 3D effect type.

0 = none

1 = raised

2 = lowered

3 = shadowed

4 = embossed

Return Value

If retrieving the current 3D effect setting, a value between 0 and 4 representing the effect type. If applying 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 with 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.

Attribute3dEffectDepth, AttributeShadowColour, AttributeHiLightColour, AttributeLoLightColour

Example

' Applies a 3D effect (embossed) to an object

GraphicsBuilder.Attribute3dEffects = 4

' Retrieves the current 3D effect applied to an object

MyVariable = GraphicsBuilder.Attribute3dEffects

Note: This function is implemented in the C++ environment as two separate functions: put_Attribute3dEffect applies a 3D effect, and get_Attribute3dEffect retrieves the current 3D effect setting.

In This Topic
TitleResults for “How to create a CRG?”Also Available in