NX Open C++ Reference Guide
|
Represents a Features::Text builder
To create a new instance of this class, use Features::FeatureCollection::CreateTextBuilder
Default values.
More...
Public Types | |
enum | FontStyleOptions { FontStyleOptionsRegular, FontStyleOptionsItalic, FontStyleOptionsBold, FontStyleOptionsBoldItalic } |
Font style options. More... | |
enum | OnFacePlacementMethodOptions { OnFacePlacementMethodOptionsCurvesOnFaces, OnFacePlacementMethodOptionsSectionPlane } |
The placement options for Features::TextBuilder::TypesOnFace type. More... | |
enum | OrientationMethodOptions { OrientationMethodOptionsNatural, OrientationMethodOptionsVector } |
The orientation options for Features::TextBuilder::TypesOnCurve type. More... | |
enum | ScriptOptions { ScriptOptionsOther, ScriptOptionsWestern, ScriptOptionsBaltic, ScriptOptionsChineseBig5, ScriptOptionsCentralEuropean, ScriptOptionsGb2312, ScriptOptionsGreek, ScriptOptionsHangul, ScriptOptionsMac, ScriptOptionsOem, ScriptOptionsCyrillic, ScriptOptionsShiftJIS, ScriptOptionsSymbol, ScriptOptionsTurkish, ScriptOptionsVietnamese, ScriptOptionsJohab, ScriptOptionsArabic, ScriptOptionsHebrew, ScriptOptionsThai } |
Script or character set options. More... | |
enum | Types { TypesPlanar, TypesOnCurve, TypesOnFace } |
Text placement type. More... | |
Public Member Functions | |
bool | CanCreateBoundingBox () |
Returns the flag indicating if bounding box can be created Created in NX7.5.1. | |
bool | CanJoinCurves () |
Returns the flag indicating if curves can be joined Created in NX7.5.1. | |
bool | CanProjectCurves () |
Returns the flag indicating if curves can be projected Created in NX7.5.1. | |
bool | CanReferenceText () |
Returns the flag indicating if text feature can reference a string expression Created in NX7.5.1. | |
bool | CanReverseIntersectionCurve () |
Returns the flag indicating if intersection curve can be reversed Created in NX7.5.1. | |
bool | CanUseKerningSpaces () |
Returns the flag indicating if kerning spaces can be used Created in NX7.5.1. | |
NXString | Font () |
Returns the font Created in NX7.5.1. | |
NXOpen::Features::TextBuilder::FontStyleOptions | FontStyle () |
Returns the font style Created in NX7.5.1. | |
NXOpen::GeometricUtilities::FrameOnPathBuilder * | FrameOnPath () |
Returns the frame on path Created in NX7.5.1. | |
bool | IsAssociative () |
Returns the flag indicating if operation is associative Created in NX7.5.1. | |
NXOpen::Section * | OnCurvePlacementProfile () |
Returns the placement profile for Features::TextBuilder::TypesOnCurve type Created in NX7.5.1. | |
NXOpen::Features::TextBuilder::OnFacePlacementMethodOptions | OnFacePlacementMethod () |
Returns the placement method for Features::TextBuilder::TypesOnFace type Created in NX7.5.1. | |
NXOpen::Section * | OnFacePlacementProfile () |
Returns the placement profile for Features::TextBuilder::TypesOnFace type Created in NX7.5.1. | |
NXOpen::Features::TextBuilder::OrientationMethodOptions | OrientationMethod () |
Returns the orientation method for Features::TextBuilder::TypesOnCurve type Created in NX7.5.1. | |
NXOpen::Direction * | OrientationVector () |
Returns the orientation vector Created in NX7.5.1. | |
NXOpen::ScCollector * | PlacementFaces () |
Returns the placement faces for Features::TextBuilder::TypesOnFace type Created in NX7.5.1. | |
NXOpen::GeometricUtilities::RectangularFrameBuilder * | PlanarFrame () |
Returns the planar frame Created in NX7.5.1. | |
NXOpen::Features::TextBuilder::ScriptOptions | Script () |
Returns the script Created in NX7.5.1. | |
NXOpen::Plane * | SectionPlane () |
Returns the section plane for Features::TextBuilder::TypesOnFace type Created in NX7.5.1. | |
void | SelectFont (const NXString &fontName, NXOpen::Features::TextBuilder::ScriptOptions script) |
Selects the font along with appropriate character set Created in NX7.5.1. | |
void | SetAssociative (bool isAssociative) |
Sets the flag indicating if operation is associative Created in NX7.5.1. | |
void | SetCanCreateBoundingBox (bool canCreateBoundingBox) |
Sets the flag indicating if bounding box can be created Created in NX7.5.1. | |
void | SetCanJoinCurves (bool canJoinCurves) |
Sets the flag indicating if curves can be joined Created in NX7.5.1. | |
void | SetCanProjectCurves (bool canProjectCurves) |
Sets the flag indicating if curves can be projected Created in NX7.5.1. | |
void | SetCanReferenceText (bool canReferenceText) |
Sets the flag indicating if text feature can reference a string expression Created in NX7.5.1. | |
void | SetCanReverseIntersectionCurve (bool canReverse) |
Sets the flag indicating if intersection curve can be reversed Created in NX7.5.1. | |
void | SetCanUseKerningSpaces (bool canUseKerningSpaces) |
Sets the flag indicating if kerning spaces can be used Created in NX7.5.1. | |
void | SetFontStyle (NXOpen::Features::TextBuilder::FontStyleOptions fontStyle) |
Sets the font style Created in NX7.5.1. | |
void | SetOnFacePlacementMethod (NXOpen::Features::TextBuilder::OnFacePlacementMethodOptions placementMethod) |
Sets the placement method for Features::TextBuilder::TypesOnFace type Created in NX7.5.1. | |
void | SetOrientationMethod (NXOpen::Features::TextBuilder::OrientationMethodOptions orientationMethod) |
Sets the orientation method for Features::TextBuilder::TypesOnCurve type Created in NX7.5.1. | |
void | SetOrientationVector (NXOpen::Direction *orientationVector) |
Sets the orientation vector Created in NX7.5.1. | |
void | SetScript (NXOpen::Features::TextBuilder::ScriptOptions script) |
Sets the script Created in NX7.5.1. | |
void | SetSectionPlane (NXOpen::Plane *sectionPlane) |
Sets the section plane for Features::TextBuilder::TypesOnFace type Created in NX7.5.1. | |
void | SetTextString (const NXString &textString) |
Sets the string to be rendered Created in NX7.5.3. | |
void | SetType (NXOpen::Features::TextBuilder::Types type) |
Sets the type Created in NX7.5.1. | |
NXOpen::Expression * | Text () |
Returns the string expression representing the text Created in NX7.5.1. | |
NXString | TextString () |
Returns the string to be rendered Created in NX7.5.3. | |
NXOpen::Features::TextBuilder::Types | Type () |
Returns the type Created in NX7.5.1. | |
void | UpdateOnOrientationVectorReversal () |
Updates the builder based on orientation vector sense Created in NX7.5.1. | |
void | UpdateOnSectionPlane () |
Updates the builder based on section plane Created in NX7.5.1. |
Represents a Features::Text builder
To create a new instance of this class, use Features::FeatureCollection::CreateTextBuilder
Default values.
Property | Value |
---|---|
CanCreateBoundingBox |
0 |
CanJoinCurves |
1 |
CanProjectCurves |
0 |
CanReferenceText |
0 |
CanUseKerningSpaces |
1 |
FontStyle |
Regular |
FrameOnPath.AnchorLocation |
Center |
FrameOnPath.Height.Value |
10 (millimeters part), 1 (inches part) |
FrameOnPath.Offset.Value |
0 (millimeters part), 0 (inches part) |
FrameOnPath.WScale |
100 |
IsAssociative |
1 |
OnFacePlacementMethod |
CurvesOnFaces |
OrientationMethod |
Natural |
PlanarFrame.AnchorLocation |
BottomCenter |
PlanarFrame.Height.Value |
10 (millimeters part), 1 (inches part) |
PlanarFrame.Shear.Value |
0 |
PlanarFrame.WScale |
100 |
Created in NX7.5.1.
The placement options for Features::TextBuilder::TypesOnFace type.
The orientation options for Features::TextBuilder::TypesOnCurve type.
Script or character set options.
Text placement type.
Returns the flag indicating if bounding box can be created
Created in NX7.5.1.
License requirements : None
Returns the flag indicating if curves can be joined
Created in NX7.5.1.
License requirements : None
Returns the flag indicating if curves can be projected
Created in NX7.5.1.
License requirements : None
Returns the flag indicating if text feature can reference a string expression
Created in NX7.5.1.
License requirements : None
Returns the flag indicating if intersection curve can be reversed
Created in NX7.5.1.
License requirements : None
Returns the flag indicating if kerning spaces can be used
Created in NX7.5.1.
License requirements : None
Returns the font
Created in NX7.5.1.
License requirements : None
Returns the font style
Created in NX7.5.1.
License requirements : None
Returns the frame on path
Created in NX7.5.1.
License requirements : None
Returns the flag indicating if operation is associative
Created in NX7.5.1.
License requirements : None
Returns the placement profile for Features::TextBuilder::TypesOnCurve type
Created in NX7.5.1.
License requirements : None
NXOpen::Features::TextBuilder::OnFacePlacementMethodOptions NXOpen::Features::TextBuilder::OnFacePlacementMethod | ( | ) |
Returns the placement method for Features::TextBuilder::TypesOnFace type
Created in NX7.5.1.
License requirements : None
Returns the placement profile for Features::TextBuilder::TypesOnFace type
Created in NX7.5.1.
License requirements : None
NXOpen::Features::TextBuilder::OrientationMethodOptions NXOpen::Features::TextBuilder::OrientationMethod | ( | ) |
Returns the orientation method for Features::TextBuilder::TypesOnCurve type
Created in NX7.5.1.
License requirements : None
Returns the orientation vector
Created in NX7.5.1.
License requirements : None
Returns the placement faces for Features::TextBuilder::TypesOnFace type
Created in NX7.5.1.
License requirements : None
Returns the planar frame
Created in NX7.5.1.
License requirements : None
Returns the script
Created in NX7.5.1.
License requirements : None
Returns the section plane for Features::TextBuilder::TypesOnFace type
Created in NX7.5.1.
License requirements : None
void NXOpen::Features::TextBuilder::SelectFont | ( | const NXString & | fontName, |
NXOpen::Features::TextBuilder::ScriptOptions | script | ||
) |
Selects the font along with appropriate character set
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
fontName | Font |
script | Character set |
void NXOpen::Features::TextBuilder::SetAssociative | ( | bool | isAssociative | ) |
Sets the flag indicating if operation is associative
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
isAssociative | isassociative |
void NXOpen::Features::TextBuilder::SetCanCreateBoundingBox | ( | bool | canCreateBoundingBox | ) |
Sets the flag indicating if bounding box can be created
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
canCreateBoundingBox | cancreateboundingbox |
void NXOpen::Features::TextBuilder::SetCanJoinCurves | ( | bool | canJoinCurves | ) |
Sets the flag indicating if curves can be joined
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
canJoinCurves | canjoincurves |
void NXOpen::Features::TextBuilder::SetCanProjectCurves | ( | bool | canProjectCurves | ) |
Sets the flag indicating if curves can be projected
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
canProjectCurves | canprojectcurves |
void NXOpen::Features::TextBuilder::SetCanReferenceText | ( | bool | canReferenceText | ) |
Sets the flag indicating if text feature can reference a string expression
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
canReferenceText | canreferencetext |
void NXOpen::Features::TextBuilder::SetCanReverseIntersectionCurve | ( | bool | canReverse | ) |
Sets the flag indicating if intersection curve can be reversed
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
canReverse | canreverse |
void NXOpen::Features::TextBuilder::SetCanUseKerningSpaces | ( | bool | canUseKerningSpaces | ) |
Sets the flag indicating if kerning spaces can be used
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
canUseKerningSpaces | canusekerningspaces |
void NXOpen::Features::TextBuilder::SetFontStyle | ( | NXOpen::Features::TextBuilder::FontStyleOptions | fontStyle | ) |
Sets the font style
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
fontStyle | fontstyle |
void NXOpen::Features::TextBuilder::SetOnFacePlacementMethod | ( | NXOpen::Features::TextBuilder::OnFacePlacementMethodOptions | placementMethod | ) |
Sets the placement method for Features::TextBuilder::TypesOnFace type
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
placementMethod | placementmethod |
void NXOpen::Features::TextBuilder::SetOrientationMethod | ( | NXOpen::Features::TextBuilder::OrientationMethodOptions | orientationMethod | ) |
Sets the orientation method for Features::TextBuilder::TypesOnCurve type
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
orientationMethod | orientationmethod |
void NXOpen::Features::TextBuilder::SetOrientationVector | ( | NXOpen::Direction * | orientationVector | ) |
Sets the orientation vector
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
orientationVector | orientationvector |
void NXOpen::Features::TextBuilder::SetScript | ( | NXOpen::Features::TextBuilder::ScriptOptions | script | ) |
Sets the script
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
script | script |
void NXOpen::Features::TextBuilder::SetSectionPlane | ( | NXOpen::Plane * | sectionPlane | ) |
Sets the section plane for Features::TextBuilder::TypesOnFace type
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
sectionPlane | sectionplane |
void NXOpen::Features::TextBuilder::SetTextString | ( | const NXString & | textString | ) |
Sets the string to be rendered
Created in NX7.5.3.
License requirements : solid_modeling ("SOLIDS MODELING")
textString | Text to be rendered |
Sets the type
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
type | type |
Returns the string expression representing the text
Created in NX7.5.1.
License requirements : None
Returns the string to be rendered
Created in NX7.5.3.
License requirements : None
Returns the type
Created in NX7.5.1.
License requirements : None
Updates the builder based on orientation vector sense
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")
Updates the builder based on section plane
Created in NX7.5.1.
License requirements : solid_modeling ("SOLIDS MODELING")