All Frameworks  Object Hierarchy  This Framework  Indexes

Shots (Collection)

The collection of all shot objects contained in the current sampled.

Method Index

Append
Adds a shot to the end of the shots collection.
CreateShot
Creates a new shot and adds it to the Shots collection.
CreateSpecificShot
Creates a new shot of a specific type and adds it to the Shots collection.
InsertAfter
Adds a shot to a specific location to the shots collection.
Item
Returns a shot using its index from the colection.
Remove
Removes a shot from the collection.

Methods


o Sub Append( iShot)
Adds a shot to the end of the shots collection.
Parameters:
iShot
The shot to be added
Example:
The following example adds a shot (called myShot to the shots collection. 
 Shots.Append (myShot)
o Func CreateShot() As
Creates a new shot and adds it to the Shots collection.
Returns:
The created shot
Example:
The following example creates a shot newShot in the Shots collection. 
 Dim newShot
 Set newShot = Shots.CreateShot
o Func CreateSpecificShot( iType) As
Creates a new shot of a specific type and adds it to the Shots collection.
Parameters:
iType
Specifies the type of the shot to be created. The legal values are FITShotPoints, FITShotDouble, FITShotSimple and FITShotGeneric. These different types correspond to the need of creating different shots for different types of objects.
Returns:
The created Shot
Example:
The following example creates a shot shot in the Shots collection. 
 Set newShots = Shots.CreateShot (FITSHOTDouble)
o Sub InsertAfter( iIndex,
iShot)
Adds a shot to a specific location to the shots collection.
Parameters:
iIndex
The value of the location of an already existing shot. Then when inserting a new shot, it will be placed after it. It is a positive integer, with the range of 1 to the value of the last shot.
iShot
The shot to be added
Example:
The following example inserts a shot after the second shot. 
 Shots.InsertAfter (2, myShot)
o Func Item( iIndex) As
Returns a shot using its index from the colection.
Parameters:
iIndex
The index of the item to retrieve from the collection of shots. Numerically, the index value corresponds to the rank of the shot in the collection (ie. the first is 1, second is 2, ...).
Returns:
The retrieved Shot
Example:
The following example retrieves the second shot from the Shots collection. 
 Dim myShot
 Set myShot = myShots.Item (2)
o Sub Remove( iIndex)
Removes a shot from the collection.
Parameters:
iIndex
The index of the shot to remove from the collection of the shots. Numerically, the index value corresponds to the rank of the shot in the collection (ie. the first is 1, second is 2, ...).
Example:
The following example removes the third shot from the Shots collection of the active document. 
 Shots.Remove (3)

Copyright © 2003, Dassault Systèmes. All rights reserved.