ProductScene (Object)

Represent the Product-Scene.
A Product-Scene stores a state of a product in a given ProductDocument.

This state is composed of product properties, graphical attibutes, activation status and position for each component of the product.


Properties


Property Type() As (Read Only)
Returns the type of the Product-Scene.
Example: 
    This example reads the type of NewSceneDelta Product-Scene.
    
    Dim type As CatSceneType
    type = NewSceneDelta.Type

Methods


Func Copy( iType) As
Creates another Product-Scene from the current one with the possibility to have a different mode.
Parameters:
iType
The Product-Scene type
Returns:
The Product-Scene created from the current one.
Example: 
    This example returns whether the CopyScene Product-Scene created from 
    the Configuration1 Product-Scene, with the DELTA mode.
    
    Dim type As CatSceneType
    type = CatSceneTypeDelta
    Dim CopyScene As ProductScene
    CopyScene = Configuration1.Copy(type)
Func ExistsInScene( iProduct) As
Returns whether the product has overloaded attributes in the Product-Scene.
Parameters:
iProduct
The product
Returns:
True if the Product-Scene overloads some of the product attributes.
Example: 
    This example returns whether the Engine product exists in
    the Configuration1 Product-Scene.
    
    ExistsInSc = Configuration1.ExistsInScene(Engine)
Func GetSceneProductData( iProduct) As
Returns the SceneProductData associated to the given product in the Product-Scene. If it does not exist yet, it is created.
Parameters:
iProduct
The product
Returns:
The SceneProductData associated to the given product.
Example: 
    This example returns SceneProductData associated to Engine in
    the NewSceneDelta Product-Scene.
    
    Dim scenePrd As SceneProductData
    type = NewSceneDelta.GetSceneProductData(Engine)