Click Macro (DriveWorks Documentation)

Click Macro

The Click Macro entity allows a model to become clickable within the DriveWorks 3D scene.

The Click Macro entity allows Geometry to be clicked in a 3D Preview Control and a Specification Macro can be run in the Specification.

The Click Macro entity adds extra functionality to the node. The Click Macro entity adds two properties:

Macro Name
Macro Argument

Information Panel

With the model node selected and the Click Macro entity added to the node, the following will be displayed in the Information Panel:

Macro Name

Enter the name of the Specification Macro to run when the model is clicked.

Enter the name of a valid Specification Macro.

Examples:

Macro Name Property Value	Result
"Cancel"	Runs the macro named Cancel.
IF(ResetFormReturn=True,"DriveControl","")	Runs the macro named DriveControl when the control ResetForm is True.

Macro Argument

The value or result of a rule, placed in the Macro Argument property, is passed into the special variable DWCurrentMacroArgument (see Info: Special Variables).

Using the Macro Argument property allows the same macro to be used, but with differing outcomes depending on when it is run.

Examples:

Macro Argument Value	Result
1	Will pass the value 1 into the special variable DWCurrentMacroArgument.
"Type A"	Will pass the text Type A into the special variable DWCurrentMacroArgument.
DWVariableTotal * QtyReturn	Will pass the result of DWVariableTotal multiplied by QtyReturn into the special variable DWCurrentMacroArgument.

Hover Appearance Name

Enter the name of an appearance that will be used when the mouse hovers over the model.

Ensure the 'Enable Hover' property is set to True in the 3D Preview.

Outline Glow Options

The common Outline Glow settings, applied to the Environment, can be overridden for each Model that has a Click Macro Entity.

See Outline Glow for more information.

Check Override Glow Color.
Set the Red, Green, Blue and Aplha channels to be the required color and transparency for this entity.

Parameter Panel

With the model node selected and the Click Macro entity added to that node, the following will be displayed in the Parameter Panel:

Macro Name

A dynamic rule can be built for the Macro Name property. The result must be the name of a Specification Macro in the DriveWorks Project.

Macro Argument

A dynmaic rule can be built for the Macro Argument property. The rule can evaluate to any value and it will be passed into the Special Variable DWCurrentMacroArgument for use in Specification Macros.

DriveWorks Pro 22 Click Macro