Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt


Panel
getQCAssignmentMin(qc, assignment)

Description

Function to retrieve the minimum value of the specified quick control assignment. The quick control assignment is determined by the Layer, the index of the quick control and the index of the assignment itself. For example, this.parent defines the parent layer of the script module as the layer that contains the quick control. The qc argument is the index of the quick control and the assignment argument is the index of the assignment with the requested minimum value. The indices of the quick controls and the assignments both start counting from 1.

Available in: Controller.

Arguments

qcThe index of the quick control.number
assignmentThe index of the quick control assignment.number

Return Values

Returns the minimum value of the specified quick control assignment.

Info

The value range is always 0 to 100 %, even if the mode of the quick control assignment is set to Relative or Switch Relative.

Example

Code Block
-- print the minimum value of the qc assignment as displayed in HALion
layer = this.parent
qc = 1
assignment = 1

qcTypeqcMode = layer:getQCAssignmentMode(qc, assignment)
qcMin = layer:getQCAssignmentMin(qc, assignment)

-- convert to bipolar range if the qc is of the type relative or switch relative
if (qcTypeqcMode == QCAssignmentTypeQCAssignmentMode.relative or qcTypeqcMode == QCAssignmentTypeQCAssignmentMode.switchRelative) then
    qcMin = qcMin * 2 - 100
end
 
print("Minimum value of '"..layer.name.."', QC "..qc..", assignment "..assignment..": "..qcMin..".")


...