CATRscInterfaces RenderingEnvironment (Object)
All Frameworks Object Hierarchy This Framework Next Indexes
RenderingEnvironment (Object)
IUnknown
|
+---IDispatch
|
+---CATBaseUnknown
|
+---CATBaseDispatch
|
+---AnyObject
|
+---RenderingEnvironment
Represents a Environment object.
Property Index
-
ActiveStatus
- Returns or sets the environment active status.
-
FaceNumber
- Returns or sets the spherical environment face number.
-
Height
- Returns or sets the cubic or cylindrical environment height value.
-
Length
- Returns or sets the cubic environment length value.
-
Radius
- Returns or sets the spherical or cylindrical environment radius value.
-
Width
- Returns or sets the cubic environment width value.
Method Index
-
GetOrigin
- Returns the coordinates of the origin of the environment.
-
GetType
- Returns the environment type.
-
GetVerticalAxis
- Returns the coordinates of the vertical axis vector of the environment.
-
GetWall
- Returns the environment walls.
-
PutOrigin
- Sets the coordinates of the origin of the environment.
-
PutVerticalAxis
- Sets the coordinates of the vertical axis vector of the environment.
Properties
o Property ActiveStatus( | ) As short |
-
Returns or sets the environment active status.
Only one environment can be active for a product.
The active status can be:
- 1: environment is activated
- 0: environment is desactivated
o Property FaceNumber( | ) As short |
-
Returns or sets the spherical environment face number.
The default value for a new spherical environment is 2.
If face number is set to 1, a mapped texture image will covered whole environment sphere.
If face number is set to 2, two different texture images can be mapped for upper hemisphere and lower hemisphere.
N.B. This property is useless for cubical and cylindrical environments.
o Property Height( | ) As double |
-
Returns or sets the cubic or cylindrical environment height value.
o Property Length( | ) As double |
-
Returns or sets the cubic environment length value.
o Property Radius( | ) As double |
-
Returns or sets the spherical or cylindrical environment radius value.
o Property Width( | ) As double |
-
Returns or sets the cubic environment width value.
Methods
-
Returns the coordinates of the origin of the environment.
These coordinates are set as an array of 3 Variants (double type).
o Func GetType( | ) As short |
-
Returns the environment type.
Possible environment types are:
- 1: Cubical environment
- 2: Spherical environment
- 3: Cylindrical environment
-
Returns the coordinates of the vertical axis vector of the environment.
These coordinates are set as an array of 3 Variants (double type).
-
Returns the environment walls.
The environment wall type can be:
- 1: North wall (for cubical and cylindrical environments)
- 2: South wall (for cubical and cylindrical environments)
- 3: East wall (for cubical environments)
- 4: West wall (for cubical environments)
- 5: Top wall (for cubical, cylindrical and shperical environments)
- 6: Bottom wall (for cubical, cylindrical and shperical environments)
-
Sets the coordinates of the origin of the environment.
These coordinates are set as an array of 3 Variants (double type).
- Example:
-
This example sets the origin of the MyEnvironment environment.
to the point with coordinates (10, 25, 15).
MyEnvironment.PutOrigin Array(10, 25, 15)
-
Sets the coordinates of the vertical axis vector of the environment.
These coordinates are set as an array of 3 Variants (double type).
Copyright © 2003, Dassault Systèmes. All rights reserved.