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:

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::NXColor *	LineColor ()
	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.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

enum NXOpen::Display::GridBuilder::LineStyleType

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

enum NXOpen::Display::GridBuilder::LineWeightType

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

Enumerator:

LineWeightTypeThin	thin
LineWeightTypeNormal	normal
LineWeightTypeThick	thick

Member Function Documentation

void NXOpen::Display::GridBuilder::InheritSettings ( NXOpen::Display::Grid * grid )

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

grid	The grid. NULL is invalid.

NXOpen::NXColor* NXOpen::Display::GridBuilder::LineColor ( )

Returns the line color
Created in NX6.0.0.

License requirements : None

double NXOpen::Display::GridBuilder::MajorLineSpacing ( )

Returns the major line spacing
Created in NX6.0.0.

License requirements : None

NXOpen::Display::GridBuilder::LineStyleType NXOpen::Display::GridBuilder::MajorLineStyle ( )

Returns the major line style
Created in NX6.0.0.

License requirements : None

NXOpen::Display::GridBuilder::LineWeightType NXOpen::Display::GridBuilder::MajorLineWeight ( )

Returns the major line weight
Created in NX6.0.0.

License requirements : None

int NXOpen::Display::GridBuilder::MinorLinesPerMajor ( )

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

License requirements : None

NXOpen::Display::GridBuilder::LineStyleType NXOpen::Display::GridBuilder::MinorLineStyle ( )

Returns the minor line style
Created in NX6.0.0.

License requirements : None

NXOpen::Display::GridBuilder::LineWeightType NXOpen::Display::GridBuilder::MinorLineWeight ( )

Returns the minor line weight
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::GridBuilder::SetLineColor ( NXOpen::NXColor * lineColor )

Sets the line color
Created in NX6.0.0.

License requirements : None

Parameters

lineColor linecolor

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

Sets the major line spacing
Created in NX6.0.0.

License requirements : None

Parameters

majorLineSpacing majorlinespacing

void NXOpen::Display::GridBuilder::SetMajorLineStyle ( NXOpen::Display::GridBuilder::LineStyleType majorLineStyle )

Sets the major line style
Created in NX6.0.0.

License requirements : None

Parameters

majorLineStyle majorlinestyle

void NXOpen::Display::GridBuilder::SetMajorLineWeight ( NXOpen::Display::GridBuilder::LineWeightType majorLineWeight )

Sets the major line weight
Created in NX6.0.0.

License requirements : None

Parameters

majorLineWeight majorlineweight

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

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

License requirements : None

Parameters

minorLinesPerMajor minorlinespermajor

void NXOpen::Display::GridBuilder::SetMinorLineStyle ( NXOpen::Display::GridBuilder::LineStyleType minorLineStyle )

Sets the minor line style
Created in NX6.0.0.

License requirements : None

Parameters

minorLineStyle minorlinestyle

void NXOpen::Display::GridBuilder::SetMinorLineWeight ( NXOpen::Display::GridBuilder::LineWeightType minorLineWeight )

Sets the minor line weight
Created in NX6.0.0.

License requirements : None

Parameters

minorLineWeight minorlineweight

void NXOpen::Display::GridBuilder::SetShow ( bool show )

Sets the show
Created in NX6.0.0.

License requirements : None

Parameters

show show

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

Sets the show major lines
Created in NX6.0.0.

License requirements : None

Parameters

showMajorLines showmajorlines

void NXOpen::Display::GridBuilder::SetShowOnTop ( bool showOnTop )

Sets the show on top
Created in NX6.0.0.

License requirements : None

Parameters

showOnTop showontop

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

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

License requirements : None

Parameters

snapPointsPerMinor snappointsperminor

void NXOpen::Display::GridBuilder::SetSnapToGrid ( bool snapToGrid )

Sets the snap to grid
Created in NX6.0.0.

License requirements : None

Parameters

snapToGrid snaptogrid

bool NXOpen::Display::GridBuilder::Show ( )

Returns the show
Created in NX6.0.0.

License requirements : None

bool NXOpen::Display::GridBuilder::ShowMajorLines ( )

Returns the show major lines
Created in NX6.0.0.

License requirements : None

bool NXOpen::Display::GridBuilder::ShowOnTop ( )

Returns the show on top
Created in NX6.0.0.

License requirements : None

int NXOpen::Display::GridBuilder::SnapPointsPerMinor ( )

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

License requirements : None

bool NXOpen::Display::GridBuilder::SnapToGrid ( )

Returns the snap to grid
Created in NX6.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Display_GridBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation