Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoSurfaceRivet Class Reference

Description

Represents a surface rivet tool.

Inheritance diagram for GoSurfaceRivet:
Inheritance graph

Public Member Functions

kStatus GoSurfaceRivet_AddMeasurement (GoSurfaceRivet tool, GoMeasurementType type, GoMeasurement *measurement)
 Adds a new rivet tool measurement. More...
 
kBool GoSurfaceRivet_AutoTiltEnabled (GoSurfaceRivet tool)
 Gets the enabled state of auto-tilt. More...
 
k64f GoSurfaceRivet_EdgeSensitivity (GoSurfaceRivet tool)
 Gets the edge sensitivity. More...
 
kStatus GoSurfaceRivet_EnableAutoTilt (GoSurfaceRivet tool, kBool enable)
 Sets the enabled state of auto-tilt. More...
 
kStatus GoSurfaceRivet_EnablePartialDetection (GoSurfaceRivet tool, kBool enable)
 Sets the enabled state of partial detection. More...
 
kStatus GoSurfaceRivet_EnableRefRegions (GoSurfaceRivet tool, kBool enable)
 Sets the enabled state of reference regions. More...
 
kStatus GoSurfaceRivet_EnableRegion (GoSurfaceRivet tool, kBool enable)
 Sets the enabled state of the tool region. More...
 
k64f GoSurfaceRivet_InnerPadding (GoSurfaceRivet tool)
 Gets the inner padding. More...
 
GoMeasurement GoSurfaceRivet_MeasurementAt (GoSurfaceRivet tool, kSize index)
 Gets the measurement at the given index. More...
 
kSize GoSurfaceRivet_MeasurementCount (GoSurfaceRivet tool)
 Gets the measurement count. More...
 
k64f GoSurfaceRivet_NominalHeight (GoSurfaceRivet tool)
 Gets the current nominal height value. More...
 
k64f GoSurfaceRivet_NominalRadius (GoSurfaceRivet tool)
 Gets the current nominal radius value. More...
 
kBool GoSurfaceRivet_PartialDetectionEnabled (GoSurfaceRivet tool)
 Gets the enabled state of partial detection. More...
 
k64f GoSurfaceRivet_RadiusTolerance (GoSurfaceRivet tool)
 Gets the current radius tolerance value. More...
 
GoSurfaceRegion2d GoSurfaceRivet_RefRegionAt (GoSurfaceRivet tool, kSize index)
 Gets a reference region object at the given index. More...
 
kSize GoSurfaceRivet_RefRegionCount (GoSurfaceRivet tool)
 Gets the reference region count. More...
 
kBool GoSurfaceRivet_RefRegionsEnabled (GoSurfaceRivet tool)
 Gets the enabled state of reference regions. More...
 
GoRegion3d GoSurfaceRivet_Region (GoSurfaceRivet tool)
 Returns the tool's region object. More...
 
kBool GoSurfaceRivet_RegionEnabled (GoSurfaceRivet tool)
 Gets the enabled state of the tool region. More...
 
kStatus GoSurfaceRivet_RemoveMeasurement (GoSurfaceRivet tool, kSize index)
 Removes a measurement at the given index. More...
 
kStatus GoSurfaceRivet_SetEdgeSensitivity (GoSurfaceRivet tool, k64f value)
 Sets the edge sensitivity. More...
 
kStatus GoSurfaceRivet_SetInnerPadding (GoSurfaceRivet tool, k64f value)
 Sets the inner padding. More...
 
kStatus GoSurfaceRivet_SetNominalHeight (GoSurfaceRivet tool, k64f nominalHeight)
 Sets the nominal height value. More...
 
kStatus GoSurfaceRivet_SetNominalRadius (GoSurfaceRivet tool, k64f nominalRadius)
 Sets the nominal radius value. More...
 
kStatus GoSurfaceRivet_SetRadiusTolerance (GoSurfaceRivet tool, k64f radiusTolerance)
 Sets the radius tolerance value. More...
 
kStatus GoSurfaceRivet_SetRefRegionCount (GoSurfaceRivet tool, kSize count)
 Sets the reference region count. More...
 
kStatus GoSurfaceRivet_SetTiltXAngle (GoSurfaceRivet tool, k64f value)
 Sets the tilt X-angle value. More...
 
kStatus GoSurfaceRivet_SetTiltYAngle (GoSurfaceRivet tool, k64f value)
 Sets the tilt Y-angle value. More...
 
kStatus GoSurfaceRivet_SetType (GoSurfaceRivet tool, GoSurfaceRivetType type)
 Sets the rivet type. More...
 
k64f GoSurfaceRivet_TiltXAngle (GoSurfaceRivet tool)
 Gets the tilt X-angle value. More...
 
k64f GoSurfaceRivet_TiltYAngle (GoSurfaceRivet tool)
 Gets the tilt Y-angle value. More...
 
GoSurfaceRivetType GoSurfaceRivet_Type (GoSurfaceRivet tool)
 Gets the rivet type. More...
 
k64f GoSurfaceRivetRadialHeightMax_Radius (GoSurfaceRivetRadialHeightMax measurement)
 Gets the radius. More...
 
k64f GoSurfaceRivetRadialHeightMean_Radius (GoSurfaceRivetRadialHeightMean measurement)
 Gets the radius. More...
 
k64f GoSurfaceRivetRadialHeightMin_Radius (GoSurfaceRivetRadialHeightMin measurement)
 Gets the radius. More...
 
k64f GoSurfaceRivetRadialHeightStdDev_Radius (GoSurfaceRivetRadialHeightStdDev measurement)
 Gets the radius. More...
 
k64f GoSurfaceRivetRadialSlopeMax_Radius (GoSurfaceRivetRadialSlopeMax measurement)
 Gets the radius. More...
 
k64f GoSurfaceRivetRadialSlopeMean_Radius (GoSurfaceRivetRadialSlopeMean measurement)
 Gets the radius. More...
 
k64f GoSurfaceRivetRadialSlopeMin_Radius (GoSurfaceRivetRadialSlopeMin measurement)
 Gets the radius. More...
 
k64f GoSurfaceRivetRadialSlopeStdDev_Radius (GoSurfaceRivetRadialSlopeStdDev measurement)
 Gets the radius. More...
 
kStatus GoSurfaceTool_SetSource (GoSurfaceTool tool, GoDataSource source)
 Sets the data source. More...
 
kStatus GoSurfaceTool_SetXAnchor (GoSurfaceTool tool, k32s id)
 Sets the X-anchoring source. More...
 
kStatus GoSurfaceTool_SetYAnchor (GoSurfaceTool tool, k32s id)
 Sets the Y-anchoring source. More...
 
kStatus GoSurfaceTool_SetZAnchor (GoSurfaceTool tool, k32s id)
 Sets the Z-anchoring source. More...
 
GoDataSource GoSurfaceTool_Source (GoSurfaceTool tool)
 Gets the data source. More...
 
k32u GoSurfaceTool_SourceOptionAt (GoSurfaceTool tool, kSize index)
 Gets the data source option at the given index. More...
 
kSize GoSurfaceTool_SourceOptionCount (GoSurfaceTool tool)
 Gets the data source option list count. More...
 
k32s GoSurfaceTool_XAnchor (GoSurfaceTool tool)
 Gets the current X-anchoring source. More...
 
kBool GoSurfaceTool_XAnchorEnabled (GoSurfaceTool tool)
 Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anchoring. More...
 
k32u GoSurfaceTool_XAnchorOptionAt (GoSurfaceTool tool, kSize index)
 Gets the X-anchoring option at the given index. More...
 
kSize GoSurfaceTool_XAnchorOptionCount (GoSurfaceTool tool)
 Gets the X-anchoring option list count. More...
 
k32s GoSurfaceTool_YAnchor (GoSurfaceTool tool)
 Gets the current Y-anchoring source. More...
 
kBool GoSurfaceTool_YAnchorEnabled (GoSurfaceTool tool)
 Returns a boolean value representing whether or not a valid Y-anchoring source has been set for Y-anchoring. More...
 
k32u GoSurfaceTool_YAnchorOptionAt (GoSurfaceTool tool, kSize index)
 Gets the Y-anchoring option at the given index. More...
 
kSize GoSurfaceTool_YAnchorOptionCount (GoSurfaceTool tool)
 Gets the Y-anchoring option list count. More...
 
k32s GoSurfaceTool_ZAnchor (GoSurfaceTool tool)
 Gets the current Z-anchoring source. More...
 
kBool GoSurfaceTool_ZAnchorEnabled (GoSurfaceTool tool)
 Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anchoring. More...
 
k32u GoSurfaceTool_ZAnchorOptionAt (GoSurfaceTool tool, kSize index)
 Gets the Z-anchoring option at the given index. More...
 
kSize GoSurfaceTool_ZAnchorOptionCount (GoSurfaceTool tool)
 Gets the Z-anchoring option list count. More...
 
GoMeasurement GoTool_FindMeasurementByType (GoTool tool, GoMeasurementType type)
 Retrieves the first found instance of a measurement for a given enumeration type. More...
 
GoMeasurement GoTool_MeasurementAt (GoTool tool, kSize index)
 Retrieves the measurement at the given index. More...
 
kSize GoTool_MeasurementCount (GoTool tool)
 Returns the measurement count. More...
 
kStatus GoTool_Name (GoTool tool, kChar *name, kSize capacity)
 Retrieves the name of the tool. More...
 
kStatus GoTool_SetName (GoTool tool, const kChar *name)
 Sets the name of the tool. More...
 
GoToolType GoTool_Type (GoTool tool)
 Retrieves the tool type enumeration value of the tool. More...
 

The documentation for this class was generated from the following files: