All Frameworks  Object Hierarchy  This Framework  Indexes

ProductScenes (Collection)

A collection of ProductScenes contained in a given ProductDocument.

Method Index

AddProductSceneFull
Creates a new FULL scene from a set of products and adds it to the ProductScenes collection.
AddProductScenePartial
Creates a new DELTA scene from a set of products and adds it to the ProductScenes collection.
Item
Returns a scene using its index or its name from the ProductScenes collection.
Remove
Removes a product-scene from the ProductScenes collection.

Methods


o Func AddProductSceneFull( iName,
iReferenceProducts) As
Creates a new FULL scene from a set of products and adds it to the ProductScenes collection.
Parameters:
iName
The name of the new scene
iReferenceProducts
Products used as root nodes of the new scene
Returns:
The created new full scene
Example:
This example creates the SpareWheel new scene from the reference product FrontRightWheel and adds the scene to the ToolKits collection. 
    Dim SpareWheel As ProductScene
    Set SpareWheel = ToolKits.AddProductSceneFull("SpareWheel", FrontRightWheel)
o Func AddProductScenePartial( iName,
iReferenceProducts) As
Creates a new DELTA scene from a set of products and adds it to the ProductScenes collection.
Parameters:
iName
The name of the new scene
iReferenceProducts
Products used as root nodes of the new scene
Returns:
The created new delta scene
Example:
This example creates the SpareWheel new scene from the reference product FrontRightWheel and adds the scene to the ToolKits collection. 
    Dim SpareWheel As ProductScene
    Set SpareWheel = ToolKits.AddProductScenePartial("SpareWheel", FrontRightWheel)
o Func Item( iIndex) As
Returns a scene using its index or its name from the ProductScenes collection.
Parameters:
iIndex
The index or the name of the ProductScene to retrieve from the collection of ProductScenes. As a numerics, this index is the rank of the ProductScene in the collection. The index of the first ProductScene in the collection is 1, and the index of the last ProductScene is Count. As a string, it is the name you assigned to the ProductScene.
Returns:
The retrieved ProductScene.
Example:
This example retrieves in ThisProductScene the ninth ProductScene, and in ThatProductScene the ProductScene named ProductScene3 from the TheProductScenes collection. 
    Dim ThisProductScene As ProductScene
    Set ThisProductScene = TheProductScenes.Item(9)
    Dim ThatProductScene As ProductScene
    Set ThatProductScene = TheProductScenes.Item("ProductScene3")
o Sub Remove( iProductScene)
Removes a product-scene from the ProductScenes collection.
Parameters:
iScene
The scene to remove.
Example:
This example removes the Engine product-scene from the ToolKits collection. 
    ToolKits.Remove Engine

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