...
Fields
Field | Type | Default | Use |
---|---|---|---|
advancing | |||
reversing | |||
easeFunction | |||
itemComponentName | string | "" | Specifies the name of a XML component for the group items. An instance of this component is created on demand for each visible item of the group. The XML component must define a specific interface as detailed in TargetGroup XML Component below. |
content | ContentNode | none | Specifies the content for the group. See Data Bindings below for more details. |
targetSet | TargetSet | invalid | Specifies the TargetSet to use to define the target regions of the items in the group. When set or modified, the target regions are immediately adjusted to use the new values. |
defaultTargetSetFocusIndex | int | 0 | For TargetSet's that do not specify a focusIndex, this value will be used as the index of the TargetSet where the focused item is located. If a TargetSet specifies any value for the focusIndex, that value will be used instead of defaultTargetSetFocusIndex. |
wrap | Boolean | false | Specifies whether the content items wraparound at the end of the TargetGroup to fill all of the targets rectangles. |
duration | Time | 0.3 seconds | Specifies the time, in seconds, to perform the animation when the animateToItem or animateToTargetSet fields are set. |
showTargetRects | Boolean | false | Specifies whether the current target rectangles (as defined in the read-only currTargetSet field's TargetSet) are drawn or not. Typically this would only be set to true while debugging a channel, although in some use cases its possible that you might want to display the current target rectangles. The rectangles are drawn using the color in the targetSet's TargetSet node's color field. |
currFocusItemIndex | float | -1.0 | Read-Only As the TargetGroup animation occurs, this field is constantly updated to represent the index of the ContentNode currently occupying the focus target region. When currFocusItemIndex is an integer value, the specified ContentNode occupies the focus target. When currFocusItemIndex has a fractional part, the value indicates that an animation is in process. For example, a value of 5.7 would indicate that items 5 and 6 are currently overlapping the focus region, with item 6 occupying 70% and item 5 the other 30%. |
currTargetSet | TargetSet | invalid | Read-Only |
itemSelected | integer | 0 | Read-Only When a group item is selected, set to the index of the selected item. |
itemFocused | integer | 0 | Read-Only When a group item gains the key focus, set to the index of the focused item. |
itemUnfocused | integer | 0 | Read-Only When a group item loses the key focus, set to the index of the unfocused item. |
jumpToItem | integer | 0 | Write-Only When set to a valid item index, causes the group to immediately update so that the specified index moves to the target region specified by the TargetSet's focusIndex. |
animateToItem | integer | 0 | Write-Only When set to a valid item index, causes the group to quickly scroll so that the specified index moves into the to the target region specified by the TargetSet's focusIndex. |
animateToTargetSet | TargetSet | invalid | Write-Only Note that if the number of rectangles in the new TargetSet's targetRects field does not match the number of rectangles in the current TargetSet's targetRects field, the results are undefined. |
...