NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::TextBuilder Class Reference

Represents a Features::Text builder
To create a new instance of this class, use Features::FeatureCollection::CreateTextBuilder
Default values. More...

Inheritance diagram for NXOpen::Features::TextBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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::FrameOnPathBuilderFrameOnPath ()
 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::SectionOnCurvePlacementProfile ()
 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::SectionOnFacePlacementProfile ()
 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::DirectionOrientationVector ()
 Returns the orientation vector
Created in NX7.5.1.
NXOpen::ScCollectorPlacementFaces ()
 Returns the placement faces for Features::TextBuilder::TypesOnFace type
Created in NX7.5.1.
NXOpen::GeometricUtilities::RectangularFrameBuilderPlanarFrame ()
 Returns the planar frame
Created in NX7.5.1.
NXOpen::Features::TextBuilder::ScriptOptions Script ()
 Returns the script
Created in NX7.5.1.
NXOpen::PlaneSectionPlane ()
 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::ExpressionText ()
 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.

Detailed Description

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.


Member Enumeration Documentation

Font style options.

Enumerator:
FontStyleOptionsRegular 

Regular style.

FontStyleOptionsItalic 

Italic style.

FontStyleOptionsBold 

Bold style.

FontStyleOptionsBoldItalic 

Bold italic style.

The placement options for Features::TextBuilder::TypesOnFace type.

Enumerator:
OnFacePlacementMethodOptionsCurvesOnFaces 

Placement on curves or edges on the faces.

OnFacePlacementMethodOptionsSectionPlane 

Placement on intersection curve created by a plane and the faces.

The orientation options for Features::TextBuilder::TypesOnCurve type.

Enumerator:
OrientationMethodOptionsNatural 

Orientation along natural curve normals.

OrientationMethodOptionsVector 

Orientation along a vector.

Script or character set options.

Enumerator:
ScriptOptionsOther 

Specifies a default character set based on current system locale.

ScriptOptionsWestern 

Specifies the English character set.

ScriptOptionsBaltic 

Specifies the Baltic (Northeastern European) character set.

ScriptOptionsChineseBig5 

Specifies the "traditional" Chinese character set.

ScriptOptionsCentralEuropean 

Specifies a Eastern European character set.

ScriptOptionsGb2312 

Specifies the "simplified" Chinese character set.

ScriptOptionsGreek 

Specifies the Greek character set.

ScriptOptionsHangul 

Specifies the Hangul Korean character set.

ScriptOptionsMac 

Specifies the Apple Macintosh character set.

ScriptOptionsOem 

Specifies a mapping to one of the OEM code pages, according to the current system locale setting.

ScriptOptionsCyrillic 

Specifies the Russian Cyrillic character set.

ScriptOptionsShiftJIS 

Specifies the Japanese character set.

ScriptOptionsSymbol 

Specifies a character set of symbols.

ScriptOptionsTurkish 

Specifies the Turkish character set.

ScriptOptionsVietnamese 

Specifies the Vietnamese character set.

ScriptOptionsJohab 

Specifies the Johab Korean character set.

ScriptOptionsArabic 

Specifies the Arabic character set.

ScriptOptionsHebrew 

Specifies the Hebrew character set.

ScriptOptionsThai 

Specifies the Thai character set.

Text placement type.

Enumerator:
TypesPlanar 

Placement on a plane.

TypesOnCurve 

Placement on a profile.

TypesOnFace 

Placement on faces.


Member Function Documentation

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

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

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

Selects the font along with appropriate character set
Created in NX7.5.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
fontNameFont
scriptCharacter 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")

Parameters:
isAssociativeisassociative
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")

Parameters:
canCreateBoundingBoxcancreateboundingbox

Sets the flag indicating if curves can be joined
Created in NX7.5.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
canJoinCurvescanjoincurves
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")

Parameters:
canProjectCurvescanprojectcurves
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")

Parameters:
canReferenceTextcanreferencetext

Sets the flag indicating if intersection curve can be reversed
Created in NX7.5.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
canReversecanreverse
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")

Parameters:
canUseKerningSpacescanusekerningspaces

Sets the font style
Created in NX7.5.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
fontStylefontstyle

Sets the placement method for Features::TextBuilder::TypesOnFace type
Created in NX7.5.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
placementMethodplacementmethod

Sets the orientation method for Features::TextBuilder::TypesOnCurve type
Created in NX7.5.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
orientationMethodorientationmethod

Sets the orientation vector
Created in NX7.5.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
orientationVectororientationvector

Sets the script
Created in NX7.5.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
scriptscript

Sets the section plane for Features::TextBuilder::TypesOnFace type
Created in NX7.5.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
sectionPlanesectionplane

Sets the string to be rendered
Created in NX7.5.3.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
textStringText to be rendered

Sets the type
Created in NX7.5.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
typetype

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")


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