Operation.referenceTool Property

Description

Get or set the tool for this operation. The document's tool library will be updated accordingly. The tool instance returned is a copy and therefore is not referenced by the operation. To change the reference tool of the operation, the new tool must be assigned to the operation, but once set it cannot be unset again. Setting the tool is only possible on operation strategies that support reference tools, an exception is thrown otherwise. Likewise null is returned if the operation strategy does not support reference tools.

Syntax

# Get the value of the property.
propertyValue = operation_var.referenceTool

# Set the value of the property.
operation_var.referenceTool = propertyValue

#include <Cam/Operations/Operation.h>

// Get the value of the property.
Ptr<Tool> propertyValue = operation_var->referenceTool();

// Set the value of the property, where value_var is a Tool.
bool returnValue = operation_var->referenceTool(value_var);

Property Value

Version