Category Dimensions, Object ProDimlocation

Function ProDimlocationTextGet


Description
Returns the location of the dimension text in a dimension. If the dimension contains an elbow, the function provides the elbow joint location along with the elbow length for locating the dimension text with respect to any model orientation.
Synopsis
#include <ProDimension.h>
ProErrorProDimlocationTextGet(
ProDimlocation data
/* (In)
The dimension location data, extracted using ProDimensionLocationGet().
*/
ProBoolean* has_elbow
/* (Out)
PRO_B_TRUE if the dimension text has an elbow joint, PRO_B_FALSE if not.
*/
ProPoint3d pnt
/* (Out)
The location, in model coordinates, of the dimension text (if has_elbow is PRO_B_FALSE) or the elbow joint (if has_elbow is PRO_B_TRUE). Pass NULL when not required.
*/
double* elbow_length
/* (Out)
The length of the elbow, in model coordinates. The sign of the value indicates whether the text is to the left of the elbow joint (elbow_length < 0) or to the right (elbow_length > 0). This length is based upon no scaling being applied to the model. See ProDimensionLocationGet() for more information. Note: From Creo 4.0, ProDimensionElbowlengthSet() has been superseded by ProDimensionElbowSet(). WARNING: If the elbow length value was set by ProDimensionElbowSet() function, then the elbow_length value retrieved by this function would be equal to the value set in the ProDimensionElbowSet() function minus the padding around the text, for all dimension types.
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more arguments is invalid.
See Also
ProDimensionLocationGet

Manual References:

  1. Drawings: Other Drawing Dimension Properties
  2. Annotations: Annotation Features and Annotations: Dimension Location
  3. Annotations: Annotation Features and Annotations: Dimension Location