Description

Retrieves an array of all the gap ranges on a node. Each gap takes up two elements in the array, for the start and end frame of the gap. Thus, the array size is twice the number of gaps on the node.

Functional area

Data retrieval

Command syntax

Syntax

getGaps node [-any] [-rot] [-sort] [-noFeedback]

Arguments

Name	Type	Required	Comments
`nodeName`	string	yes	Node to get gap ranges for.

Flags

Name	Argument type	Exclusive to	Comments
`any`	—	—	Specifies that a gap can exist on any of the sub channels. The default is that the gap must exist on all sub channels.
`rot`	—	—	Specifies that the rotation channel be searched for gaps. The default is to search on the translation channel.
`sort`	—	—	Specifies that the gap ranges be sorted in ascending order of gap size. The default is to leave the gap ranges in chronological order.
`noFeedback`	—	—	—

Return value

integer array

Examples

// Get all the gaps on the RFWT.
int $gaps[]; 
int $i, $count;
 
// Get all the gaps.
$gaps = `getGaps "RFWT"`;
 
// Print out their sizes.
$count = `getCount $gaps`;
for( $i = 0; 
     $i < $count; 
     $i += 2 )
        { 
           print int( $gaps[$i+1] - $gaps[$i] + 1 );
}

Shogun 1.14 Documentation

getGaps