NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Display::GridBuilder Class Reference

Represents the builder for adding a grid Display::Grid
This is an abstract class, and cannot be instantiated. More...

Inheritance diagram for NXOpen::Display::GridBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Display::BoundedGridBuilder NXOpen::Display::DatumPlaneGridBuilder NXOpen::Display::PlaneGridBuilder

List of all members.

Public Types

enum  LineStyleType {
  LineStyleTypeSolid, LineStyleTypeDashed, LineStyleTypePhantom, LineStyleTypeCenterline,
  LineStyleTypeDotted, LineStyleTypeLongdash, LineStyleTypeDotdash
}
 Specifies line style to be used for major and minor lines of the grid. More...
enum  LineWeightType { LineWeightTypeThin, LineWeightTypeNormal, LineWeightTypeThick }
 Specifies line weight to be used for major and minor lines of the grid. More...

Public Member Functions

void InheritSettings (NXOpen::Display::Grid *grid)
 Inherits the settings from the specified grid.
NXOpen::NXColorLineColor ()
 Returns the line color
Created in NX6.0.0.
double MajorLineSpacing ()
 Returns the major line spacing
Created in NX6.0.0.
NXOpen::Display::GridBuilder::LineStyleType MajorLineStyle ()
 Returns the major line style
Created in NX6.0.0.
NXOpen::Display::GridBuilder::LineWeightType MajorLineWeight ()
 Returns the major line weight
Created in NX6.0.0.
int MinorLinesPerMajor ()
 Returns the minor lines per major
Created in NX6.0.0.
NXOpen::Display::GridBuilder::LineStyleType MinorLineStyle ()
 Returns the minor line style
Created in NX6.0.0.
NXOpen::Display::GridBuilder::LineWeightType MinorLineWeight ()
 Returns the minor line weight
Created in NX6.0.0.
void SetLineColor (NXOpen::NXColor *lineColor)
 Sets the line color
Created in NX6.0.0.
void SetMajorLineSpacing (double majorLineSpacing)
 Sets the major line spacing
Created in NX6.0.0.
void SetMajorLineStyle (NXOpen::Display::GridBuilder::LineStyleType majorLineStyle)
 Sets the major line style
Created in NX6.0.0.
void SetMajorLineWeight (NXOpen::Display::GridBuilder::LineWeightType majorLineWeight)
 Sets the major line weight
Created in NX6.0.0.
void SetMinorLinesPerMajor (int minorLinesPerMajor)
 Sets the minor lines per major
Created in NX6.0.0.
void SetMinorLineStyle (NXOpen::Display::GridBuilder::LineStyleType minorLineStyle)
 Sets the minor line style
Created in NX6.0.0.
void SetMinorLineWeight (NXOpen::Display::GridBuilder::LineWeightType minorLineWeight)
 Sets the minor line weight
Created in NX6.0.0.
void SetShow (bool show)
 Sets the show
Created in NX6.0.0.
void SetShowMajorLines (bool showMajorLines)
 Sets the show major lines
Created in NX6.0.0.
void SetShowOnTop (bool showOnTop)
 Sets the show on top
Created in NX6.0.0.
void SetSnapPointsPerMinor (int snapPointsPerMinor)
 Sets the snap points per minor
Created in NX6.0.0.
void SetSnapToGrid (bool snapToGrid)
 Sets the snap to grid
Created in NX6.0.0.
bool Show ()
 Returns the show
Created in NX6.0.0.
bool ShowMajorLines ()
 Returns the show major lines
Created in NX6.0.0.
bool ShowOnTop ()
 Returns the show on top
Created in NX6.0.0.
int SnapPointsPerMinor ()
 Returns the snap points per minor
Created in NX6.0.0.
bool SnapToGrid ()
 Returns the snap to grid
Created in NX6.0.0.

Detailed Description

Represents the builder for adding a grid Display::Grid
This is an abstract class, and cannot be instantiated.



Created in NX6.0.0.


Member Enumeration Documentation

Specifies line style to be used for major and minor lines of the grid.

Enumerator:
LineStyleTypeSolid 

solid

LineStyleTypeDashed 

dashed

LineStyleTypePhantom 

phantom

LineStyleTypeCenterline 

centerline

LineStyleTypeDotted 

dotted

LineStyleTypeLongdash 

longdash

LineStyleTypeDotdash 

dotdash

Specifies line weight to be used for major and minor lines of the grid.

Enumerator:
LineWeightTypeThin 

thin

LineWeightTypeNormal 

normal

LineWeightTypeThick 

thick


Member Function Documentation

Inherits the settings from the specified grid.

These includes settings such as Display::GridBuilder::MajorLineSpacing and Display::GridBuilder::SetMajorLineSpacing .


Created in NX6.0.0.

License requirements : None

Parameters:
gridThe grid. NULL is invalid.

Returns the line color
Created in NX6.0.0.



License requirements : None

Returns the major line spacing
Created in NX6.0.0.



License requirements : None

Returns the major line style
Created in NX6.0.0.



License requirements : None

Returns the major line weight
Created in NX6.0.0.



License requirements : None

Returns the minor lines per major
Created in NX6.0.0.



License requirements : None

Returns the minor line style
Created in NX6.0.0.



License requirements : None

Returns the minor line weight
Created in NX6.0.0.



License requirements : None

Sets the line color
Created in NX6.0.0.



License requirements : None

Parameters:
lineColorlinecolor
void NXOpen::Display::GridBuilder::SetMajorLineSpacing ( double  majorLineSpacing)

Sets the major line spacing
Created in NX6.0.0.



License requirements : None

Parameters:
majorLineSpacingmajorlinespacing

Sets the major line style
Created in NX6.0.0.



License requirements : None

Parameters:
majorLineStylemajorlinestyle

Sets the major line weight
Created in NX6.0.0.



License requirements : None

Parameters:
majorLineWeightmajorlineweight
void NXOpen::Display::GridBuilder::SetMinorLinesPerMajor ( int  minorLinesPerMajor)

Sets the minor lines per major
Created in NX6.0.0.



License requirements : None

Parameters:
minorLinesPerMajorminorlinespermajor

Sets the minor line style
Created in NX6.0.0.



License requirements : None

Parameters:
minorLineStyleminorlinestyle

Sets the minor line weight
Created in NX6.0.0.



License requirements : None

Parameters:
minorLineWeightminorlineweight

Sets the show
Created in NX6.0.0.



License requirements : None

Parameters:
showshow
void NXOpen::Display::GridBuilder::SetShowMajorLines ( bool  showMajorLines)

Sets the show major lines
Created in NX6.0.0.



License requirements : None

Parameters:
showMajorLinesshowmajorlines

Sets the show on top
Created in NX6.0.0.



License requirements : None

Parameters:
showOnTopshowontop
void NXOpen::Display::GridBuilder::SetSnapPointsPerMinor ( int  snapPointsPerMinor)

Sets the snap points per minor
Created in NX6.0.0.



License requirements : None

Parameters:
snapPointsPerMinorsnappointsperminor

Sets the snap to grid
Created in NX6.0.0.



License requirements : None

Parameters:
snapToGridsnaptogrid

Returns the show
Created in NX6.0.0.



License requirements : None

Returns the show major lines
Created in NX6.0.0.



License requirements : None

Returns the show on top
Created in NX6.0.0.



License requirements : None

Returns the snap points per minor
Created in NX6.0.0.



License requirements : None

Returns the snap to grid
Created in NX6.0.0.



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.