All Frameworks  Object Hierarchy  This Framework  Indexes

Scene (Object)

Represent the scene.
A 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.

Method Index

GetDefinition
Returns the product's definition.
GetDescription
Returns the product's description.
GetMasterShapeRepresentation
Retrieves the product's master shape representation.
GetMove
Returns the product's move object.
GetNomenclature
Returns the product's nomenclature.
GetPartNumber
Returns the product's part number.
GetPosition
Returns the product's position object in the scene.
GetRevision
Returns the product's revision number.
GetSource
Returns the product's source.
HasAMasterShapeRepresentation
Returns whether the product has a master shape representation in the scene.
UpgradeToFull
Create a ProductScene in Full mode from the current Scene.
UpgradeToPartial
Create a ProductScene in Partial mode from the current Scene.

Methods


o Func GetDefinition( iProduct) As
Returns the product's definition.
Parameters:
iProduct
The product.
Returns:
The product's definition.
Example:
This example retrieves the Engine product's definition in the Configuration1 scene. 
    Dim Definition As String
    Definition = Configuration1.GetDefinition(Engine)
o Func GetDescription( iProduct) As
Returns the product's description.
Parameters:
iProduct
The product.
Returns:
The product's description.
Example:
This example retrieves the Engine product's description in the Configuration1 scene. 
    Dim Description As String
    Description = Configuration1.GetDescription(Engine)
o Func GetMasterShapeRepresentation( iProduct,
iLoadIfNecessary) As
Retrieves the product's master shape representation.
Parameters:
iProduct.
The product
iLoadIfNecessary
Parameter to set to True if the master shape representation should be loaded to determine if it exists, or to False otherwise.
Returns:
The product's master shape representation.
Example:
This example retrieves the Engine product's master shape representation in the Configuration1 scene. 
    Dim MSRep As Object
    Set MSRep = Configuration1.GetMasterShapeRepresentation(Engine)
o Func GetMove( iProduct) As
Returns the product's move object. The move object is aggregated by the product object and itself aggregates a movable object to which you can apply a move transformation by means of an isometry matrix. It moves your product master shape representation according to this isometry.
Parameters:
iProduct
The product
Returns:
The move.
Example:
This example retrieves the EngineMove move from the Engine product in the Configuration1 scene. 
    Dim EngineMove As Move
    Set EngineMove = Configuration1.GetMove(Engine)
o Func GetNomenclature( iProduct) As
Returns the product's nomenclature.
Parameters:
iProduct
The product.
Returns:
The product's nomenclature.
Example:
This example retrieves the Engine product's nomenclature in the Configuration1 scene. 
    Dim Nomenclature As String
    Nomenclature = Configuration1.GetNomenclature(Engine)
o Func GetPartNumber( iProduct) As
Returns the product's part number.
Parameters:
iProduct
The product.
Returns:
The product's part number.
Example:
This example retrieves the Engine product's part number in the Configuration1 scene. 
    Dim PartNumber As String
    PartNumber = Configuration1.GetPartNumber(Engine)
o Func GetPosition( iProduct) As
Returns the product's position object in the scene. The position object is the object aggregated by the product object that holds the position of the master shape representation in the space.
Parameters:
iProduct
The product
Returns:
The position.
Example:
This example retrieves the EnginePosition position from the Engine product in the Configuration1 scene. 
    Dim EnginePosition As Position
    Set EnginePosition = Configuration1.GetPosition(Engine)
o Func GetRevision( iProduct) As
Returns the product's revision number.
Parameters:
iProduct
The product.
Returns:
The product's revision number.
Example:
This example retrieves the Engine product's revision number in the Configuration1 scene. 
    Dim Revision As String
    Revision = Configuration1.GetRevision(Engine)
o Func GetSource( iProduct) As
Returns the product's source.
Parameters:
iProduct
The product.
Returns:
The product's source.
Example:
This example retrieves the Engine product's source in the Configuration1 scene. 
    Dim Source
    Source = Configuration1.GetSource(Engine)
o Func HasAMasterShapeRepresentation( iProduct) As
Returns whether the product has a master shape representation in the scene.
Parameters:
iProduct
The product
Returns:
True if the product has a master shape representation.
Example:
This example returns whether the Engine product has a master shape representation in the Configuration1 scene. 
    HasMSRep = Configuration1.HasAMasterShapeRepresentation(Engine)
o Func UpgradeToFull() As
Create a ProductScene in Full mode from the current Scene.
Returns:
The new ProductScene.
Example:
This example creates the FullScene ProductScene from the Configuration1 scene. 
    Dim FullScene As ProductScene
    Set FullScene = Configuration1.UpgradeToFull
o Func UpgradeToPartial() As
Create a ProductScene in Partial mode from the current Scene.
Returns:
The new ProductScene.
Example:
This example creates the PartialScene ProductScene from the Configuration1 scene. 
    Dim PartialScene As ProductScene
    Set PartialScene = Configuration1.UpgradeToPartial

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