NX Open C++ Reference Guide
Public Member Functions | Public Attributes | List of all members
NXOpen::Annotations::Lettering Struct Reference

Specifies lettering data. More...

Public Member Functions

 Lettering (double sizeInitial, double characterSpaceFactorInitial, double aspectRatioInitial, double lineSpaceFactorInitial, const NXOpen::Annotations::TextCfw &cfwInitial, bool italicInitial, double symbolAspectRatioInitial)
 Constructor for the Lettering struct. More...
 

Public Attributes

double AspectRatio
 Aspect ratio for a character. More...
 
NXOpen::Annotations::TextCfw Cfw
 Color, font, and width for lettering. More...
 
double CharacterSpaceFactor
 Multiplier applied to font's standard character spacing. More...
 
bool Italic
 italicized text for standard font text More...
 
double LineSpaceFactor
 Multiplier applied to font's standard line spacing. More...
 
double Size
 Height of a character. More...
 
double SymbolAspectRatio
 Symbol aspect ratio (this only applies to symbols when using standard fonts) This value controls the aspect ratio of text control sequences such as the diameter symbol (represented by the &x3C;O&x3E; text control sequence), the counterbore symbol (represented by the &x3C;&x23;C&x3E; text control sequence), the degree symbol (represented by the &x3C;&x24;s&x3E; text control sequence), the true position symbol (represented by the &x3C;&x26;10&x3E; text control sequence), etc. More...
 

Detailed Description

Specifies lettering data.

Constructor & Destructor Documentation

NXOpen::Annotations::Lettering::Lettering ( double  sizeInitial,
double  characterSpaceFactorInitial,
double  aspectRatioInitial,
double  lineSpaceFactorInitial,
const NXOpen::Annotations::TextCfw cfwInitial,
bool  italicInitial,
double  symbolAspectRatioInitial 
)

Constructor for the Lettering struct.

Parameters
sizeInitialHeight of a character
characterSpaceFactorInitialMultiplier applied to font's standard character spacing
aspectRatioInitialAspect ratio for a character
lineSpaceFactorInitialMultiplier applied to font's standard line spacing
cfwInitialColor, font, and width for lettering
italicInitialitalicized text for standard font text
symbolAspectRatioInitialSymbol aspect ratio (this only applies to symbols when using standard fonts) This value controls the aspect ratio of text control sequences such as the diameter symbol (represented by the &x3C;O&x3E; text control sequence), the counterbore symbol (represented by the &x3C;&x23;C&x3E; text control sequence), the degree symbol (represented by the &x3C;&x24;s&x3E; text control sequence), the true position symbol (represented by the &x3C;&x26;10&x3E; text control sequence), etc. This value cannot be negative. The default value is zero. A zero value indicates that the aspect ratio for a character will be used for the symbol aspect ratio.

Member Data Documentation

double NXOpen::Annotations::Lettering::AspectRatio

Aspect ratio for a character.

NXOpen::Annotations::TextCfw NXOpen::Annotations::Lettering::Cfw

Color, font, and width for lettering.

double NXOpen::Annotations::Lettering::CharacterSpaceFactor

Multiplier applied to font's standard character spacing.

bool NXOpen::Annotations::Lettering::Italic

italicized text for standard font text

double NXOpen::Annotations::Lettering::LineSpaceFactor

Multiplier applied to font's standard line spacing.

double NXOpen::Annotations::Lettering::Size

Height of a character.

double NXOpen::Annotations::Lettering::SymbolAspectRatio

Symbol aspect ratio (this only applies to symbols when using standard fonts) This value controls the aspect ratio of text control sequences such as the diameter symbol (represented by the &x3C;O&x3E; text control sequence), the counterbore symbol (represented by the &x3C;&x23;C&x3E; text control sequence), the degree symbol (represented by the &x3C;&x24;s&x3E; text control sequence), the true position symbol (represented by the &x3C;&x26;10&x3E; text control sequence), etc.

This value cannot be negative. The default value is zero. A zero value indicates that the aspect ratio for a character will be used for the symbol aspect ratio.


The documentation for this struct was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.