All Frameworks  Object Hierarchy  This Framework  Indexes

SceneProductData (Object)

The interface to access a CATIASceneProduct

Using this prefered syntax will enable mkdoc to document your class.

Property Index

Activation
Returns / Set the scene product's activation state.
Hidden
Returns / Set the scene product's hide/show mode.
Move
Returns the scene product's move object.
Position
Returns the scene product's position object.

Method Index

GetRealColor
Returns / Set the scene product's color and inheritance.
SetRealColor
Returns / Set the scene product's color and inheritance.

Properties


o Property Activation() As
Returns / Set the scene product's activation state.
Example:
This example retrieves the activation state of the scenePrd SceneProductData. 
    IsActivated = scenePrd.Hidden
o Property Hidden() As
Returns / Set the scene product's hide/show mode.
Example:
This example retrieves the hide/show mode of the scenePrd SceneProductData. 
    IsHidden = scenePrd.Hidden
o Property Move() As (Read Only)
Returns the scene product's move object. It aggregates a movable object to which you can apply a move transformation by means of an isometry matrix. It moves your product shape representation according to this isometry.
Example:
This example retrieves the EngineMove move in the scenePrd SceneProductData. 
    Dim EngineMove As Move
    Set EngineMove = scenePrd.GetMove
o Property Position() As (Read Only)
Returns the scene product's position object. The position object is the object aggregated by the SceneProductData object that holds the position of the master shape representation in the space in scene.
Example:
This example retrieves the EnginePosition position in the scenePrd SceneProductData. 
    Dim EnginePosition As Position
    Set EnginePosition = scenePrd.GetPosition

Methods


o Sub GetRealColor( oRed,
oGreen,
oBlue,
oInheritance)
Returns / Set the scene product's color and inheritance.
Parameters:
iRed
A value between 0 and 255
iGreen
A value between 0 and 255
iBlue
A value between 0 and 255
iInheritance
Legal value:
0
No heritance
1
Heritance
Example:
This example retrieves the activation state of the scenePrd SceneProductData. 
	Dim r, g, b, inh
    scenePrd.GetRealColor r, g, b, inh
o Sub SetRealColor( iRed,
iGreen,
iBlue,
iInheritance)
Returns / Set the scene product's color and inheritance.
Parameters:
iRed
A value between 0 and 255
iGreen
A value between 0 and 255
iBlue
A value between 0 and 255
iInheritance
Legal value:
0
No heritance
1
Heritance
Example:
This example retrieves the activation state of the scenePrd SceneProductData. 
    scenePrd.SetRealColor 255,0,0,1

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