NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Fields::DisplayPropertiesBuilder Class Reference

Represents a builder class for editing display properties of a Fields::Field. More...

Inheritance diagram for NXOpen::Fields::DisplayPropertiesBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  DepDispTypeEnum { DepDispTypeEnumSymbol, DepDispTypeEnumSurface, DepDispTypeEnumSurfaceEdges, DepDispTypeEnumHide }
 Field Dep Disp Type. More...
enum  DepDomColorEnum { DepDomColorEnumInherit, DepDomColorEnumSpecified, DepDomColorEnumSpectrum }
 Field Dep Dom Color. More...
enum  DepLabelValueEnum {
  DepLabelValueEnumNone, DepLabelValueEnumMinimumMaximum, DepLabelValueEnumMaximum, DepLabelValueEnumMinimum,
  DepLabelValueEnumAll
}
 Field Dep Label Value. More...
enum  DispResolutionEnum {
  DispResolutionEnumCoarse, DispResolutionEnumStandard, DispResolutionEnumFine, DispResolutionEnumExtraFine,
  DispResolutionEnumSuperFine, DispResolutionEnumUltraFine
}
 Field Disp Resolution. More...
enum  IndepDomDispType {
  IndepDomDispTypeNormal, IndepDomDispTypePoint, IndepDomDispTypePlusSign, IndepDomDispTypeAsterisk,
  IndepDomDispTypeCircle, IndepDomDispTypePoundSign, IndepDomDispTypeCross, IndepDomDispTypeSquare,
  IndepDomDispTypeTriangle, IndepDomDispTypeDiamond, IndepDomDispTypeCenterline, IndepDomDispTypeHide
}
 Field Indep Dom Disp. More...
enum  LineFontEnum {
  LineFontEnumSolid, LineFontEnumDashed, LineFontEnumPhantom, LineFontEnumCenterline,
  LineFontEnumDotted, LineFontEnumLongDashed, LineFontEnumDottedDashed
}
 Field Line Display Fonts. More...
enum  LineWidthEnum { LineWidthEnumNormal, LineWidthEnumThin, LineWidthEnumThick }
 Field Line Widths. More...
enum  TblPointTypeEnum { TblPointTypeEnumHide, TblPointTypeEnumShow }
 Field Tbl Point Type. More...
enum  ValuesEnum {
  ValuesEnumHide, ValuesEnumPoint, ValuesEnumPlusSign, ValuesEnumAsterisk,
  ValuesEnumCircle, ValuesEnumPoundSign, ValuesEnumCross, ValuesEnumSquare,
  ValuesEnumTriangle, ValuesEnumDiamond, ValuesEnumCenterline
}
 Field Values. More...

Public Member Functions

NXOpen::NXColorAxisColor ()
 Returns the axis color
Created in NX6.0.1.
NXOpen::NXColorBasicColor ()
 Returns the basic color
Created in NX6.0.1.
NXOpen::Fields::DisplayPropertiesBuilder::DepDispTypeEnum DepDispType ()
 Returns the dep disp type
Created in NX6.0.1.
NXOpen::Fields::DisplayPropertiesBuilder::DepDomColorEnum DepDomColor ()
 Returns the dep dom color
Created in NX6.0.1.
NXOpen::Fields::DisplayPropertiesBuilder::DepLabelValueEnum DepLabelValues ()
 Returns the dep label values
Created in NX6.0.1.
NXOpen::NXColorDepSelColor ()
 Returns the dep sel color
Created in NX6.0.1.
double DepSymbolSize ()
 Returns the dep symbol size
Created in NX6.0.1.
NXOpen::Fields::DisplayPropertiesBuilder::DispResolutionEnum DisplayResolution ()
 Returns the display resolution
Created in NX6.0.1.
double DummyScale ()
 Returns the dummy scale
Created in NX6.0.1.
bool FaceAnalysis ()
 Returns the face analysis
Created in NX6.0.1.
NXOpen::Fields::DisplayPropertiesBuilder::IndepDomDispType IndepDispType ()
 Returns the indep disp type
Created in NX6.0.1.
NXOpen::NXColorLabelColor ()
 Returns the label color
Created in NX6.0.1.
int Layer ()
 Returns the layer
Created in NX6.0.1.
NXOpen::Fields::DisplayPropertiesBuilder::LineFontEnum LineFont ()
 Returns the line font
Created in NX6.0.1.
NXOpen::Fields::DisplayPropertiesBuilder::LineWidthEnum LineWidth ()
 Returns the line width
Created in NX6.0.1.
bool PartiallyShaded ()
 Returns the partially shaded
Created in NX6.0.1.
void SetAxisColor (NXOpen::NXColor *axisColor)
 Sets the axis color
Created in NX6.0.1.
void SetBasicColor (NXOpen::NXColor *basicColor)
 Sets the basic color
Created in NX6.0.1.
void SetDepDispType (NXOpen::Fields::DisplayPropertiesBuilder::DepDispTypeEnum depDispType)
 Sets the dep disp type
Created in NX6.0.1.
void SetDepDomColor (NXOpen::Fields::DisplayPropertiesBuilder::DepDomColorEnum depDomColor)
 Sets the dep dom color
Created in NX6.0.1.
void SetDepLabelValues (NXOpen::Fields::DisplayPropertiesBuilder::DepLabelValueEnum depLabelValues)
 Sets the dep label values
Created in NX6.0.1.
void SetDepSelColor (NXOpen::NXColor *depSelColor)
 Sets the dep sel color
Created in NX6.0.1.
void SetDepSymbolSize (double depSymbolSize)
 Sets the dep symbol size
Created in NX6.0.1.
void SetDisplayResolution (NXOpen::Fields::DisplayPropertiesBuilder::DispResolutionEnum displayResolution)
 Sets the display resolution
Created in NX6.0.1.
void SetDummyScale (double dummyScale)
 Sets the dummy scale
Created in NX6.0.1.
void SetFaceAnalysis (bool faceAnalysis)
 Sets the face analysis
Created in NX6.0.1.
void SetIndepDispType (NXOpen::Fields::DisplayPropertiesBuilder::IndepDomDispType indepDispType)
 Sets the indep disp type
Created in NX6.0.1.
void SetLabelColor (NXOpen::NXColor *labelColor)
 Sets the label color
Created in NX6.0.1.
void SetLayer (int layer)
 Sets the layer
Created in NX6.0.1.
void SetLineFont (NXOpen::Fields::DisplayPropertiesBuilder::LineFontEnum lineFont)
 Sets the line font
Created in NX6.0.1.
void SetLineWidth (NXOpen::Fields::DisplayPropertiesBuilder::LineWidthEnum lineWidth)
 Sets the line width
Created in NX6.0.1.
void SetPartiallyShaded (bool partiallyShaded)
 Sets the partially shaded
Created in NX6.0.1.
void SetShowAxis (bool showAxis)
 Sets the show axis
Created in NX6.0.1.
void SetShowLabels (bool showLabels)
 Sets the show labels
Created in NX6.0.1.
void SetShowMapTopo (bool showMapTopo)
 Sets the show map topo
Created in NX6.0.1.
void SetShowUndefinedValues (NXOpen::Fields::DisplayPropertiesBuilder::ValuesEnum showUndefinedValues)
 Sets the show undefined values
Created in NX6.0.1.
void SetSpectrumLevels (int spectrumLevels)
 Sets the spectrum levels
Created in NX6.0.1.
void SetSurfaceOffset (double surfaceOffset)
 Sets the surface offset
Created in NX6.0.1.
void SetTblDepColor (NXOpen::NXColor *tblDepColor)
 Sets the table dependent color
Created in NX6.0.1.
void SetTblDepDomColor (NXOpen::Fields::DisplayPropertiesBuilder::DepDomColorEnum depDomColor)
 Sets the table dependent domain color
Created in NX7.5.0.
void SetTblDepLabelValues (NXOpen::Fields::DisplayPropertiesBuilder::DepLabelValueEnum tblDepLabelValues)
 Sets the table dependent label values
Created in NX7.5.0.
void SetTblDepPtType (NXOpen::Fields::DisplayPropertiesBuilder::TblPointTypeEnum tblDepPtType)
 Sets the tbl dep pt type
Created in NX6.0.1.
void SetTblDepSymbolSize (double tblDepSymbolSize)
 Sets the table dependent symbol size
Created in NX7.5.0.
void SetTblIndepColor (NXOpen::NXColor *tblIndepColor)
 Sets the tbl indep color
Created in NX6.0.1.
void SetTblIndepPtType (NXOpen::Fields::DisplayPropertiesBuilder::ValuesEnum tblIndepPtType)
 Sets the tbl indep pt type
Created in NX6.0.1.
void SetTranslucency (int translucency)
 Sets the translucency
Created in NX6.0.1.
void SetUndefValueColor (NXOpen::NXColor *undefValueColor)
 Sets the undef value color
Created in NX6.0.1.
bool ShowAxis ()
 Returns the show axis
Created in NX6.0.1.
bool ShowLabels ()
 Returns the show labels
Created in NX6.0.1.
bool ShowMapTopo ()
 Returns the show map topo
Created in NX6.0.1.
NXOpen::Fields::DisplayPropertiesBuilder::ValuesEnum ShowUndefinedValues ()
 Returns the show undefined values
Created in NX6.0.1.
int SpectrumLevels ()
 Returns the spectrum levels
Created in NX6.0.1.
double SurfaceOffset ()
 Returns the surface offset
Created in NX6.0.1.
NXOpen::NXColorTblDepColor ()
 Returns the table dependent color
Created in NX6.0.1.
NXOpen::Fields::DisplayPropertiesBuilder::DepDomColorEnum TblDepDomColor ()
 Returns the table dependent domain color
Created in NX7.5.0.
NXOpen::Fields::DisplayPropertiesBuilder::DepLabelValueEnum TblDepLabelValues ()
 Returns the table dependent label values
Created in NX7.5.0.
NXOpen::Fields::DisplayPropertiesBuilder::TblPointTypeEnum TblDepPtType ()
 Returns the tbl dep pt type
Created in NX6.0.1.
double TblDepSymbolSize ()
 Returns the table dependent symbol size
Created in NX7.5.0.
NXOpen::NXColorTblIndepColor ()
 Returns the tbl indep color
Created in NX6.0.1.
NXOpen::Fields::DisplayPropertiesBuilder::ValuesEnum TblIndepPtType ()
 Returns the tbl indep pt type
Created in NX6.0.1.
int Translucency ()
 Returns the translucency
Created in NX6.0.1.
NXOpen::NXColorUndefValueColor ()
 Returns the undef value color
Created in NX6.0.1.

Detailed Description

Represents a builder class for editing display properties of a Fields::Field.


Used to edit a Fields::Field display properties.

To create a new instance of this class, use Fields::FieldManager::CreateDisplayPropertiesBuilder
Default values.

Property Value

DepDispType

Symbol

DepDomColor

Inherit

DepLabelValues

None

DepSymbolSize

0

DisplayResolution

Standard

DummyScale

0

FaceAnalysis

0

IndepDispType

Normal

Layer

1

LineFont

Solid

LineWidth

Normal

PartiallyShaded

0

ShowAxis

0

ShowLabels

0

ShowMapTopo

0

ShowUndefinedValues

Hide

SpectrumLevels

3

SurfaceOffset

0

TblDepPtType

Hide

TblIndepPtType

Hide

Translucency

0


Created in NX6.0.1.


Member Enumeration Documentation

Field Dep Disp Type.

Enumerator:
DepDispTypeEnumSymbol 

symbol

DepDispTypeEnumSurface 

surface

DepDispTypeEnumSurfaceEdges 

surface edges

DepDispTypeEnumHide 

hide

Field Dep Dom Color.

Enumerator:
DepDomColorEnumInherit 

inherit

DepDomColorEnumSpecified 

specified

DepDomColorEnumSpectrum 

spectrum

Field Dep Label Value.

Enumerator:
DepLabelValueEnumNone 

none

DepLabelValueEnumMinimumMaximum 

minimum maximum

DepLabelValueEnumMaximum 

maximum

DepLabelValueEnumMinimum 

minimum

DepLabelValueEnumAll 

all

Field Disp Resolution.

Enumerator:
DispResolutionEnumCoarse 

coarse

DispResolutionEnumStandard 

standard

DispResolutionEnumFine 

fine

DispResolutionEnumExtraFine 

extra fine

DispResolutionEnumSuperFine 

super fine

DispResolutionEnumUltraFine 

ultra fine

Field Indep Dom Disp.

Enumerator:
IndepDomDispTypeNormal 

normal

IndepDomDispTypePoint 

point

IndepDomDispTypePlusSign 

plus sign

IndepDomDispTypeAsterisk 

asterisk

IndepDomDispTypeCircle 

circle

IndepDomDispTypePoundSign 

pound sign

IndepDomDispTypeCross 

cross

IndepDomDispTypeSquare 

square

IndepDomDispTypeTriangle 

triangle

IndepDomDispTypeDiamond 

diamond

IndepDomDispTypeCenterline 

centerline

IndepDomDispTypeHide 

hide

Field Line Display Fonts.

Enumerator:
LineFontEnumSolid 

Solid.

LineFontEnumDashed 

Dashed.

LineFontEnumPhantom 

Phantom.

LineFontEnumCenterline 

Centerline.

LineFontEnumDotted 

Dotted.

LineFontEnumLongDashed 

LongDashed.

LineFontEnumDottedDashed 

dotted dashed

Field Line Widths.

Enumerator:
LineWidthEnumNormal 

Normal.

LineWidthEnumThin 

Thin.

LineWidthEnumThick 

Thick.

Field Tbl Point Type.

Enumerator:
TblPointTypeEnumHide 

hide

TblPointTypeEnumShow 

show

Field Values.

Enumerator:
ValuesEnumHide 

hide

ValuesEnumPoint 

point

ValuesEnumPlusSign 

plus sign

ValuesEnumAsterisk 

asterisk

ValuesEnumCircle 

circle

ValuesEnumPoundSign 

pound sign

ValuesEnumCross 

cross

ValuesEnumSquare 

square

ValuesEnumTriangle 

triangle

ValuesEnumDiamond 

diamond

ValuesEnumCenterline 

centerline


Member Function Documentation

Returns the axis color
Created in NX6.0.1.



License requirements : None

Returns the basic color
Created in NX6.0.1.



License requirements : None

Returns the dep disp type
Created in NX6.0.1.



License requirements : None

Returns the dep dom color
Created in NX6.0.1.



License requirements : None

Returns the dep label values
Created in NX6.0.1.



License requirements : None

Returns the dep sel color
Created in NX6.0.1.



License requirements : None

Returns the dep symbol size
Created in NX6.0.1.



License requirements : None

Returns the display resolution
Created in NX6.0.1.



License requirements : None

Returns the dummy scale
Created in NX6.0.1.



License requirements : None

Returns the face analysis
Created in NX6.0.1.



License requirements : None

Returns the indep disp type
Created in NX6.0.1.



License requirements : None

Returns the label color
Created in NX6.0.1.



License requirements : None

Returns the layer
Created in NX6.0.1.



License requirements : None

Returns the line font
Created in NX6.0.1.



License requirements : None

Returns the line width
Created in NX6.0.1.



License requirements : None

Returns the partially shaded
Created in NX6.0.1.



License requirements : None

Sets the axis color
Created in NX6.0.1.



License requirements : None

Parameters:
axisColoraxiscolor

Sets the basic color
Created in NX6.0.1.



License requirements : None

Parameters:
basicColorbasiccolor

Sets the dep disp type
Created in NX6.0.1.



License requirements : None

Parameters:
depDispTypedepdisptype

Sets the dep dom color
Created in NX6.0.1.



License requirements : None

Parameters:
depDomColordepdomcolor

Sets the dep label values
Created in NX6.0.1.



License requirements : None

Parameters:
depLabelValuesdeplabelvalues

Sets the dep sel color
Created in NX6.0.1.



License requirements : None

Parameters:
depSelColordepselcolor

Sets the dep symbol size
Created in NX6.0.1.



License requirements : None

Parameters:
depSymbolSizedepsymbolsize

Sets the display resolution
Created in NX6.0.1.



License requirements : None

Parameters:
displayResolutiondisplayresolution

Sets the dummy scale
Created in NX6.0.1.



License requirements : None

Parameters:
dummyScaledummyscale

Sets the face analysis
Created in NX6.0.1.



License requirements : None

Parameters:
faceAnalysisfaceanalysis

Sets the indep disp type
Created in NX6.0.1.



License requirements : None

Parameters:
indepDispTypeindepdisptype

Sets the label color
Created in NX6.0.1.



License requirements : None

Parameters:
labelColorlabelcolor

Sets the layer
Created in NX6.0.1.



License requirements : None

Parameters:
layerlayer

Sets the line font
Created in NX6.0.1.



License requirements : None

Parameters:
lineFontlinefont

Sets the line width
Created in NX6.0.1.



License requirements : None

Parameters:
lineWidthlinewidth

Sets the partially shaded
Created in NX6.0.1.



License requirements : None

Parameters:
partiallyShadedpartiallyshaded

Sets the show axis
Created in NX6.0.1.



License requirements : None

Parameters:
showAxisshowaxis

Sets the show labels
Created in NX6.0.1.



License requirements : None

Parameters:
showLabelsshowlabels

Sets the show map topo
Created in NX6.0.1.



License requirements : None

Parameters:
showMapToposhowmaptopo

Sets the show undefined values
Created in NX6.0.1.



License requirements : None

Parameters:
showUndefinedValuesshowundefinedvalues

Sets the spectrum levels
Created in NX6.0.1.



License requirements : None

Parameters:
spectrumLevelsspectrumlevels

Sets the surface offset
Created in NX6.0.1.



License requirements : None

Parameters:
surfaceOffsetsurfaceoffset

Sets the table dependent color
Created in NX6.0.1.



License requirements : None

Parameters:
tblDepColortbldepcolor

Sets the table dependent domain color
Created in NX7.5.0.



License requirements : None

Parameters:
depDomColordepdomcolor

Sets the table dependent label values
Created in NX7.5.0.



License requirements : None

Parameters:
tblDepLabelValuestbldeplabelvalues

Sets the tbl dep pt type
Created in NX6.0.1.



License requirements : None

Parameters:
tblDepPtTypetbldeppttype

Sets the table dependent symbol size
Created in NX7.5.0.



License requirements : None

Parameters:
tblDepSymbolSizetbldepsymbolsize

Sets the tbl indep color
Created in NX6.0.1.



License requirements : None

Parameters:
tblIndepColortblindepcolor

Sets the tbl indep pt type
Created in NX6.0.1.



License requirements : None

Parameters:
tblIndepPtTypetblindeppttype

Sets the translucency
Created in NX6.0.1.



License requirements : None

Parameters:
translucencytranslucency

Sets the undef value color
Created in NX6.0.1.



License requirements : None

Parameters:
undefValueColorundefvaluecolor

Returns the show axis
Created in NX6.0.1.



License requirements : None

Returns the show labels
Created in NX6.0.1.



License requirements : None

Returns the show map topo
Created in NX6.0.1.



License requirements : None

Returns the show undefined values
Created in NX6.0.1.



License requirements : None

Returns the spectrum levels
Created in NX6.0.1.



License requirements : None

Returns the surface offset
Created in NX6.0.1.



License requirements : None

Returns the table dependent color
Created in NX6.0.1.



License requirements : None

Returns the table dependent domain color
Created in NX7.5.0.



License requirements : None

Returns the table dependent label values
Created in NX7.5.0.



License requirements : None

Returns the tbl dep pt type
Created in NX6.0.1.



License requirements : None

Returns the table dependent symbol size
Created in NX7.5.0.



License requirements : None

Returns the tbl indep color
Created in NX6.0.1.



License requirements : None

Returns the tbl indep pt type
Created in NX6.0.1.



License requirements : None

Returns the translucency
Created in NX6.0.1.



License requirements : None

Returns the undef value color
Created in NX6.0.1.



License requirements : None


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