|
Gocator API
|
Represents a surface opening tool.
Inheritance diagram for GoSurfaceOpening:Public Member Functions | |
| GoSurfaceOpeningAngle | GoSurfaceOpening_AngleMeasurement (GoSurfaceOpening tool) |
| Returns a GoSurfaceOpening Angle measurement object. More... | |
| k64f | GoSurfaceOpening_AngleTolerance (GoSurfaceOpening tool) |
| Gets the angle tolerance. More... | |
| kBool | GoSurfaceOpening_AutoTiltEnabled (GoSurfaceOpening tool) |
| Gets the enabled state of auto-tilt. More... | |
| kStatus | GoSurfaceOpening_EnableAutoTilt (GoSurfaceOpening tool, kBool enable) |
| Sets the enabled state of auto-tilt. More... | |
| kStatus | GoSurfaceOpening_EnablePartialDetection (GoSurfaceOpening tool, kBool enable) |
| Sets the enabled state of partial detection. More... | |
| kStatus | GoSurfaceOpening_EnableRefRegions (GoSurfaceOpening tool, kBool enable) |
| Sets the enabled state of reference regions. More... | |
| kStatus | GoSurfaceOpening_EnableRegion (GoSurfaceOpening tool, kBool enable) |
| Sets the enabled state of the tool region. More... | |
| GoSurfaceOpeningLength | GoSurfaceOpening_LengthMeasurement (GoSurfaceOpening tool) |
| Returns a GoSurfaceOpening Length measurement object. More... | |
| k64f | GoSurfaceOpening_LengthTolerance (GoSurfaceOpening tool) |
| Gets the length tolerance. More... | |
| k64f | GoSurfaceOpening_NominalAngle (GoSurfaceOpening tool) |
| Gets the nominal angle. More... | |
| k64f | GoSurfaceOpening_NominalLength (GoSurfaceOpening tool) |
| Gets the nominal length. More... | |
| k64f | GoSurfaceOpening_NominalRadius (GoSurfaceOpening tool) |
| Gets the nominal radius. More... | |
| k64f | GoSurfaceOpening_NominalWidth (GoSurfaceOpening tool) |
| Gets the nominal width. More... | |
| kBool | GoSurfaceOpening_PartialDetectionEnabled (GoSurfaceOpening tool) |
| Gets the enabled state of partial detection. More... | |
| GoSurfaceRegion2d | GoSurfaceOpening_RefRegionAt (GoSurfaceOpening tool, kSize index) |
| Gets the reference region object at the specified index. More... | |
| kSize | GoSurfaceOpening_RefRegionCount (GoSurfaceOpening tool) |
| Gets the reference region count. More... | |
| kBool | GoSurfaceOpening_RefRegionsEnabled (GoSurfaceOpening tool) |
| Gets the enabled state of reference regions. More... | |
| GoRegion3d | GoSurfaceOpening_Region (GoSurfaceOpening tool) |
| Returns the region object for the tool. More... | |
| kBool | GoSurfaceOpening_RegionEnabled (GoSurfaceOpening tool) |
| Gets the enabled state of the tool region. More... | |
| kStatus | GoSurfaceOpening_SetAngleTolerance (GoSurfaceOpening tool, k64f value) |
| Sets the angle tolerance. More... | |
| kStatus | GoSurfaceOpening_SetLengthTolerance (GoSurfaceOpening tool, k64f value) |
| Sets the length tolerance. More... | |
| kStatus | GoSurfaceOpening_SetNominalAngle (GoSurfaceOpening tool, k64f value) |
| Sets the nominal angle. More... | |
| kStatus | GoSurfaceOpening_SetNominalLength (GoSurfaceOpening tool, k64f value) |
| Sets the nominal length. More... | |
| kStatus | GoSurfaceOpening_SetNominalRadius (GoSurfaceOpening tool, k64f value) |
| Sets the nominal radius. More... | |
| kStatus | GoSurfaceOpening_SetNominalWidth (GoSurfaceOpening tool, k64f value) |
| Sets the nominal width. More... | |
| kStatus | GoSurfaceOpening_SetRefRegionCount (GoSurfaceOpening tool, kSize count) |
| Sets the reference region count. More... | |
| kStatus | GoSurfaceOpening_SetTiltXAngle (GoSurfaceOpening tool, k64f value) |
| Sets the tilt X-angle. More... | |
| kStatus | GoSurfaceOpening_SetTiltYAngle (GoSurfaceOpening tool, k64f value) |
| Sets the tilt Y-angle. More... | |
| kStatus | GoSurfaceOpening_SetWidthTolerance (GoSurfaceOpening tool, k64f value) |
| Sets the width tolerance. More... | |
| k64f | GoSurfaceOpening_TiltXAngle (GoSurfaceOpening tool) |
| Gets the tilt X-angle. More... | |
| k64f | GoSurfaceOpening_TiltYAngle (GoSurfaceOpening tool) |
| Gets the tilt Y-angle. More... | |
| GoSurfaceOpeningType | GoSurfaceOpening_Type (GoSurfaceOpening tool) |
| Gets the surface opening type. More... | |
| GoSurfaceOpeningWidth | GoSurfaceOpening_WidthMeasurement (GoSurfaceOpening tool) |
| Returns a GoSurfaceOpening Width measurement object. More... | |
| k64f | GoSurfaceOpening_WidthTolerance (GoSurfaceOpening tool) |
| Gets the width tolerance. More... | |
| GoSurfaceOpeningX | GoSurfaceOpening_XMeasurement (GoSurfaceOpening tool) |
| Returns a GoSurfaceOpening X measurement object. More... | |
| GoSurfaceOpeningY | GoSurfaceOpening_YMeasurement (GoSurfaceOpening tool) |
| Returns a GoSurfaceOpening Y measurement object. More... | |
| GoSurfaceOpeningZ | GoSurfaceOpening_ZMeasurement (GoSurfaceOpening tool) |
| Returns a GoSurfaceOpening Z measurement object. 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... | |
| GoSurfaceOpeningAngle GoSurfaceOpening_AngleMeasurement | ( | GoSurfaceOpening | tool | ) |
Returns a GoSurfaceOpening Angle measurement object.
| tool | GoSurfaceOpening object. |
| k64f GoSurfaceOpening_AngleTolerance | ( | GoSurfaceOpening | tool | ) |
Gets the angle tolerance.
| tool | GoSurfaceOpening object. |
| kBool GoSurfaceOpening_AutoTiltEnabled | ( | GoSurfaceOpening | tool | ) |
Gets the enabled state of auto-tilt.
| tool | GoSurfaceOpening object. |
| kStatus GoSurfaceOpening_EnableAutoTilt | ( | GoSurfaceOpening | tool, |
| kBool | enable | ||
| ) |
Sets the enabled state of auto-tilt.
| tool | GoSurfaceOpening object. |
| enable | kTRUE to enable auto-tilt and kFALSE to disable it. |
| kStatus GoSurfaceOpening_EnablePartialDetection | ( | GoSurfaceOpening | tool, |
| kBool | enable | ||
| ) |
Sets the enabled state of partial detection.
| tool | GoSurfaceOpening object. |
| enable | kTRUE to enable partial detection and kFALSE to disable it. |
| kStatus GoSurfaceOpening_EnableRefRegions | ( | GoSurfaceOpening | tool, |
| kBool | enable | ||
| ) |
Sets the enabled state of reference regions.
| tool | GoSurfaceOpening object. |
| enable | kTRUE to enable reference regions and kFALSE to disable it. |
| kStatus GoSurfaceOpening_EnableRegion | ( | GoSurfaceOpening | tool, |
| kBool | enable | ||
| ) |
Sets the enabled state of the tool region.
| tool | GoSurfaceOpening object. |
| enable | kTRUE to enable the tool region and kFALSE to disable it. |
| GoSurfaceOpeningLength GoSurfaceOpening_LengthMeasurement | ( | GoSurfaceOpening | tool | ) |
Returns a GoSurfaceOpening Length measurement object.
| tool | GoSurfaceOpening object. |
| k64f GoSurfaceOpening_LengthTolerance | ( | GoSurfaceOpening | tool | ) |
Gets the length tolerance.
| tool | GoSurfaceOpening object. |
| k64f GoSurfaceOpening_NominalAngle | ( | GoSurfaceOpening | tool | ) |
Gets the nominal angle.
| tool | GoSurfaceOpening object. |
| k64f GoSurfaceOpening_NominalLength | ( | GoSurfaceOpening | tool | ) |
| k64f GoSurfaceOpening_NominalRadius | ( | GoSurfaceOpening | tool | ) |
| k64f GoSurfaceOpening_NominalWidth | ( | GoSurfaceOpening | tool | ) |
| kBool GoSurfaceOpening_PartialDetectionEnabled | ( | GoSurfaceOpening | tool | ) |
Gets the enabled state of partial detection.
| tool | GoSurfaceOpening object. |
| GoSurfaceRegion2d GoSurfaceOpening_RefRegionAt | ( | GoSurfaceOpening | tool, |
| kSize | index | ||
| ) |
Gets the reference region object at the specified index.
| tool | GoSurfaceOpening object. |
| index | The index with which to retrieve a reference region. |
| kSize GoSurfaceOpening_RefRegionCount | ( | GoSurfaceOpening | tool | ) |
Gets the reference region count.
| tool | GoSurfaceOpening object. |
| kBool GoSurfaceOpening_RefRegionsEnabled | ( | GoSurfaceOpening | tool | ) |
Gets the enabled state of reference regions.
| tool | GoSurfaceOpening object. |
| GoRegion3d GoSurfaceOpening_Region | ( | GoSurfaceOpening | tool | ) |
Returns the region object for the tool.
| tool | GoSurfaceOpening object. |
| kBool GoSurfaceOpening_RegionEnabled | ( | GoSurfaceOpening | tool | ) |
Gets the enabled state of the tool region.
| tool | GoSurfaceOpening object. |
| kStatus GoSurfaceOpening_SetAngleTolerance | ( | GoSurfaceOpening | tool, |
| k64f | value | ||
| ) |
Sets the angle tolerance.
| tool | GoSurfaceOpening object. |
| value | The angle tolerance to set (in degrees). |
| kStatus GoSurfaceOpening_SetLengthTolerance | ( | GoSurfaceOpening | tool, |
| k64f | value | ||
| ) |
Sets the length tolerance.
| tool | GoSurfaceOpening object. |
| value | The length tolerance to set (in mm). |
| kStatus GoSurfaceOpening_SetNominalAngle | ( | GoSurfaceOpening | tool, |
| k64f | value | ||
| ) |
Sets the nominal angle.
| tool | GoSurfaceOpening object. |
| value | The nominal angle to set (in degrees). |
| kStatus GoSurfaceOpening_SetNominalLength | ( | GoSurfaceOpening | tool, |
| k64f | value | ||
| ) |
Sets the nominal length.
| tool | GoSurfaceOpening object. |
| value | The nominal length to set (in mm). |
| kStatus GoSurfaceOpening_SetNominalRadius | ( | GoSurfaceOpening | tool, |
| k64f | value | ||
| ) |
Sets the nominal radius.
| tool | GoSurfaceOpening object. |
| value | The nominal radius to set (in mm). |
| kStatus GoSurfaceOpening_SetNominalWidth | ( | GoSurfaceOpening | tool, |
| k64f | value | ||
| ) |
Sets the nominal width.
| tool | GoSurfaceOpening object. |
| value | The nominal width to set (in mm). |
| kStatus GoSurfaceOpening_SetRefRegionCount | ( | GoSurfaceOpening | tool, |
| kSize | count | ||
| ) |
Sets the reference region count.
| tool | GoSurfaceOpening object. |
| count | The reference region count to set. |
| kStatus GoSurfaceOpening_SetTiltXAngle | ( | GoSurfaceOpening | tool, |
| k64f | value | ||
| ) |
Sets the tilt X-angle.
| tool | GoSurfaceOpening object. |
| value | The tilt X-angle to set. |
| kStatus GoSurfaceOpening_SetTiltYAngle | ( | GoSurfaceOpening | tool, |
| k64f | value | ||
| ) |
Sets the tilt Y-angle.
| tool | GoSurfaceOpening object. |
| value | The tilt Y-angle to set. |
| kStatus GoSurfaceOpening_SetWidthTolerance | ( | GoSurfaceOpening | tool, |
| k64f | value | ||
| ) |
Sets the width tolerance.
| tool | GoSurfaceOpening object. |
| value | The width tolerance to set (in mm). |
| k64f GoSurfaceOpening_TiltXAngle | ( | GoSurfaceOpening | tool | ) |
| k64f GoSurfaceOpening_TiltYAngle | ( | GoSurfaceOpening | tool | ) |
| GoSurfaceOpeningType GoSurfaceOpening_Type | ( | GoSurfaceOpening | tool | ) |
Gets the surface opening type.
| tool | GoSurfaceOpening object. |
| GoSurfaceOpeningWidth GoSurfaceOpening_WidthMeasurement | ( | GoSurfaceOpening | tool | ) |
Returns a GoSurfaceOpening Width measurement object.
| tool | GoSurfaceOpening object. |
| k64f GoSurfaceOpening_WidthTolerance | ( | GoSurfaceOpening | tool | ) |
Gets the width tolerance.
| tool | GoSurfaceOpening object. |
| GoSurfaceOpeningX GoSurfaceOpening_XMeasurement | ( | GoSurfaceOpening | tool | ) |
Returns a GoSurfaceOpening X measurement object.
| tool | GoSurfaceOpening object. |
| GoSurfaceOpeningY GoSurfaceOpening_YMeasurement | ( | GoSurfaceOpening | tool | ) |
Returns a GoSurfaceOpening Y measurement object.
| tool | GoSurfaceOpening object. |
| GoSurfaceOpeningZ GoSurfaceOpening_ZMeasurement | ( | GoSurfaceOpening | tool | ) |
Returns a GoSurfaceOpening Z measurement object.
| tool | GoSurfaceOpening object. |
|
inherited |
Sets the data source.
| tool | GoSurfaceTool object. |
| source | GoDataSource object. |
|
inherited |
Sets the X-anchoring source.
| tool | GoSurfaceTool object. |
| id | The measurement ID of a valid X-anchoring source. |
|
inherited |
Sets the Y-anchoring source.
| tool | GoSurfaceTool object. |
| id | The measurement ID of a valid Y-anchoring source. |
|
inherited |
Sets the Z-anchoring source.
| tool | GoSurfaceTool object. |
| id | The measurement ID of a valid Z-anchoring source. |
|
inherited |
|
inherited |
Gets the data source option at the given index.
| tool | GoSurfaceTool object. |
| index | The index of the option list to access. |
|
inherited |
Gets the data source option list count.
| tool | GoSurfaceTool object. |
|
inherited |
Gets the current X-anchoring source.
| tool | GoSurfaceTool object. |
|
inherited |
Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anchoring.
| tool | GoSurfaceTool object. |
|
inherited |
Gets the X-anchoring option at the given index.
| tool | GoSurfaceTool object. |
| index | The index of the option list to access. |
|
inherited |
Gets the X-anchoring option list count.
| tool | GoSurfaceTool object. |
|
inherited |
Gets the current Y-anchoring source.
| tool | GoSurfaceTool object. |
|
inherited |
Returns a boolean value representing whether or not a valid Y-anchoring source has been set for Y-anchoring.
| tool | GoSurfaceTool object. |
|
inherited |
Gets the Y-anchoring option at the given index.
| tool | GoSurfaceTool object. |
| index | The index of the option list to access. |
|
inherited |
Gets the Y-anchoring option list count.
| tool | GoSurfaceTool object. |
|
inherited |
Gets the current Z-anchoring source.
| tool | GoSurfaceTool object. |
|
inherited |
Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anchoring.
| tool | GoSurfaceTool object. |
|
inherited |
Gets the Z-anchoring option at the given index.
| tool | GoSurfaceTool object. |
| index | The index of the option list to access. |
|
inherited |
Gets the Z-anchoring option list count.
| tool | GoSurfaceTool object. |
|
inherited |
Retrieves the first found instance of a measurement for a given enumeration type.
| tool | GoTool object. |
| type | A GoMeasurementType representing the measurement type to find in the given tool. |
|
inherited |
Retrieves the measurement at the given index.
| tool | GoTool object. |
| index | The index of the measurement. |
|
inherited |
|
inherited |
Retrieves the name of the tool.
| tool | GoTool object. |
| name | Receives the name of the tool. |
| capacity | The maximum capacity of the name array. |
|
inherited |
Sets the name of the tool.
| tool | GoTool object. |
| name | The name to be set for the tool. |
|
inherited |
Retrieves the tool type enumeration value of the tool.
| tool | GoTool object. |