Tutorial Toolkit Function Descriptions > Graphics > Clipping Planes
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Clipping Planes
 
ga_clip_plane_clip_planes_get
( aclips_list )
Description:
Gets the list of arb clipping planes.
Input:
None.
Output:
STRING
aclips_list [ ]
List of arb clipping planes.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_clip_planes_get (p. 74) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_create
( name )
Description:
Creates an arb clipping plane.
Input:
STRING
name[]
Name of plane.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000154
An arbitrary clipping plane with the given name is already in the database.
11000097
There is not enough disk space to complete operation.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_create (p. 75) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_delete
( name )
Description:
Delete a plane.
Input:
STRING
name[]
Name of plane.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000158
The specified arbitrary clipping plane was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_delete (p. 76) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_direction_get
( name, value )
Description:
Get the arb clipping plane direction.
Input:
STRING
name[]
Arb clipping plane name.
Output:
REAL
value (3)
Direction of arb clipping plane.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000158
The specified arbitrary clipping plane was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_direction_get (p. 78) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_direction_set
( name, value, up_flag )
Description:
Set the arb clipping plane direction.
Input:
STRING
name[]
Arb clipping plane name.
REAL
value (3)
Direction of arb clipping plane.
LOGICAL
up_flag
Calculate up vector or not.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000158
The specified arbitrary clipping plane was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_direction_set (p. 79) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_icon_get
( name, value )
 
Description:
Get the status whether the icon is displayed.
Input:
STRING
name[]
Arb clipping plane name.
Output:
INTEGER
value
Flag specifying if an icon should be displayed at arb clipping plane.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000158
The specified arbitrary clipping plane was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_icon_get (p. 81) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_icon_set
( name, value )
Description:
Set the status whether the icon is displayed.
Input:
STRING
name[]
Arb clipping plane name.
INTEGER
value
Up of arb clipping plane.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000158
The specified arbitrary clipping plane was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
See example for ga_clip_plane_direction_set, 106. See also ga_clip_plane_icon_set (p. 82) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_location_get
( name, value )
Description:
Get the location of arb clipping plane.
Input:
STRING
name[]
Arb clipping plane name.
Output:
REAL
value (3)
Location of arb clipping plane (x, y, z).
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000158
The specified arbitrary clipping plane was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_location_get (p. 83) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_location_set
( name, value )
Description:
Set the location of arb clipping plane.
Input:
STRING
name
Arb clipping plane name.
REAL
value (3)
Location of arb clipping plane (x, y, z).
Output:
 
 
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000158
The specified arbitrary clipping plane was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
See example for ga_clip_plane_direction_set, 106. See also ga_clip_plane_location_set (p. 85) in the MSC Acumen Toolkit - Code Examples.
ga_clip_plane_movement_get
( name, value )
 
Description:
Get whether the arb clipping plane moves with the model or not.
Input:
STRING
name[]
Arb clipping plane name.
Output:
INTEGER
value (3)
Flag specifying whether arb clipping plane moves with the model or not.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000158
The specified arbitrary clipping plane was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_movement_get (p. 86) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_movement_set
( name, value )
 
Description:
Set the status whether the arb clipping plane should move with the model.
Input:
STRING
name[]
Arb clipping plane name.
INTEGER
value
Flag specifying if the arb clipping plane should move with the model.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000158
The specified arbitrary clipping plane was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
See example for ga_clip_plane_direction_set, 106. See also ga_clip_plane_movement_set (p. 88) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_nclip_planes_get
( naclips )
Description:
Gets the number of arb clipping planes.
Input:
None.
Output:
INTEGER
naclips
Number of arb clipping planes.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_nclip_planes_get (p. 90) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_nposted_get
( naclips )
Description:
Gets the number of posted arb clipping planes.
Input:
None.
Output:
INTEGER
naclips
Number of posted arb clipping planes.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_nposted_get (p. 91) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_post
( name )
Description:
Post a plane.
Input:
STRING
name[]
Name of plane.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000158
The specified arbitrary clipping plane was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_post (p. 93) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_posted_get
( aclips_list )
Description:
Gets the list of posted arb clipping planes.
Input:
None.
Output:
STRING
aclips_list [ ] ( )
List of arb clipping planes.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_posted_get (p. 94) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_unpost
( name )
Description:
Unpost a plane.
Input:
STRING
name[]
Name of plane.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000158
The specified arbitrary clipping plane was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_unpost (p. 96) in the MSC Acumen Toolkit - Code Examples.
 
ga_clip_plane_up_set
( name, value )
Description:
Set the arb clipping plane Up.
Input:
STRING
name[]
Arb clipping plane name.
REAL
value (3)
Up of arb clipping plane.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000155
The arbitrary clipping plane name is invalid.
11000158
The specified arbitrary clipping plane was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_clip_plane_up_set (p. 97) in the MSC Acumen Toolkit - Code Examples.
 
clip_plane_ar_calc
( name, rx, ry, rz, new_dir, new_up )
 
Description:
Update the indicated clipping plane’s data to reflect the axes relative rotations about the x, y and z axes.
Input:
STRING
name[]
Name of clipping plane.
REAL
rx
Rotation about the x-axis.
REAL
ry
Rotation about the y-axis.
REAL
rz
Rotation about the z-axis.
Output:
REAL
new_dir(3)
New dir.
REAL
new_up(3)
New up.
INTEGER
<Return Value>
Error status.
Example:
Please see clip_plane_ar_calc (p. 66) in the MSC Acumen Toolkit - Code Examples.
 
clip_plane_zoom_calc
( name, factor, new_loc )
 
 
Description:
Update the indicated clipping plane’s location point to reflect the zoom ( not in db ).
Input:
STRING
name[]
Name of clipping plane.
REAL
factor
Factor.
Output:
REAL
new_loc(3)
New location.
INTEGER
<Return Value>
Error status.
Example:
Please see clip_plane_zoom_calc (p. 68) in the MSC Acumen Toolkit - Code Examples.