PCL Reference Manual > Geometry Functions > Utlities
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Utlities
ge_get_midsurface_thickness
(p3_label, thickness)
Description:
This function will return the thickness attribute value of a parasolid midsurface.
Input:
INTEGER
p3_label
This value specifies the external patran surface label of the midsurface.
Output:
REAL
thickness
This value returns the value of the thickness attribute attached to the parasolid midsurface.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
-1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks:
This function can return the following error ids:
 
1
The surface selected is not a parasolid midsurface.
-1
The parasolid surface does not have a thickness attribute.
13000122
The surface requested was not found.
13000213
A database lookup failed to locate the target index key.
 
sgm_get_curve_length
(curve_id, length)
 
Description:
This function gets the curve length for a curve.
Input:
INTEGER
curve_id
This values specifies the curve id
Output:
REAL
length
This value returns the curve length.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
Example:
 
sgm_get_solid_volume
(solid_id, volume)
 
Description:
This function gets the solid volume for a solid.
Input:
INTEGER
solid_id
This values specifies the solid id
Output:
REAL
volume
This value returns the solid volume.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
 
 
sgm_get_surface_area
(surface_id, area)
 
Description:
This function gets the surface area for a surface.
Input:
INTEGER
surface_id
This values specifies the surface id
Output:
REAL
area
This value returns the surface area.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
 
sgm_intersect_curves
(curve1, curve2, distance, u1, u2, xyz1, xyz2)
 
Description:
This function calculates the minimum distance between two curves.
Input:
REAL
curve1()
This value specifies the data for the first curve.
REAL
curve2()
This value specifies the data for the second curve.
Output:
REAL
distance
This value returns the minimum distance between the two curves.
REAL
u1
This value returns the parametric location of the minimum distance point, relative to the first curve.
REAL
u2
This value returns the parametric location of the minimum distance point, relative to the second curve.
REAL
xyz1(3)
This value returns he model space location of the minimum distance point, relative to the first curve.
REAL
xyz2(3)
This value returns the model space location of the minimum distance point, relative to the second curve.
INTEGER
<Return Value>
This function can return any value and the value returned has no meaning.
Error Conditions:
None.
Remarks:
This function returns a value that has no meaning, can have any value, and may change from call to call.
The input values curve1 and curve2 can be any length that is appropriate for the geometric data table that will be passed to this function.
See the listing for this function in Broken, Obsolete, Modified and New Functions for further information.
Example:
Please see sgm_intersect_curves (p. 33) in the PCL Reference Manual Examples.
 
sgm_nearest_point_on_surface
(point, surface, u, v, xyz)
 
Description:
This function will find the point on a surface that is nearest to a specified point.
Input:
REAL
point(3)
This value specifies the model space location of the point near the surface.
REAL
surface()
This value specifies the surface.
Output:
REAL
u
This value returns one coordinate of the parametric location of the point on the surface nearest to the specified point.
REAL
v
This value returns the other coordinate of the parametric location of the point on the surface nearest to the specified point.
REAL
xyz(3,4)
This argument returns the model space location, derivatives, and normal of the point on the surface nearest to the specified point.
INTEGER
<Return Value>
This function can return any value and the value returned has no meaning.
Error Conditions:
None.
Remarks:
This function returns a value that has no meaning, can have any value, and may change from call to call.
The input value surface can be any length that is appropriate for the geometric data table that will be passed to this function.
The accuracy of the results of this function are in part dependent on the global model tolerance. This function uses the global model tolerance to determine when to stop its calculation.
See the listing for this function in Broken, Obsolete, Modified and New Functions for further information.
Example:
Please see sgm_nearest_point_on_surface (p. 34) in the PCL Reference Manual Examples.