Represents the builder for adding a datum plane grid Display::DatumPlaneGrid to a datum plane. More...

Inheritance diagram for NXOpen::Display::DatumPlaneGridBuilder:

Public Types
enum	GridOrientationType { GridOrientationTypeFromDatumPlane, GridOrientationTypeCustom }
	Specifies grid orientation option to be used for grid display. More...

Public Types inherited from NXOpen::Display::BoundedGridBuilder
enum	LabelReferenceType { LabelReferenceTypeLocal, LabelReferenceTypeWcs, LabelReferenceTypeAbsolute }
	Specifies label reference. More...

enum	ShowLabelType { ShowLabelTypeAlways, ShowLabelTypeParalleltoView, ShowLabelTypeNone }
	Specifies label option to be used for grid label display. More...

Public Types inherited from NXOpen::Display::GridBuilder
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
std::vector< NXOpen::DatumPlane * >	GetDatumPlanes ()
	Get the list of datum planes.

NXOpen::Display::DatumPlaneGridBuilder::GridOrientationType	GridOrientation ()
	Returns the grid orientation Created in NX6.0.0.

void	SetDatumPlanes (const std::vector< NXOpen::DatumPlane * > &datumPlanes)
	Set the list of datum planes.

void	SetGridOrientation (NXOpen::Display::DatumPlaneGridBuilder::GridOrientationType gridOrientation)
	Sets the grid orientation Created in NX6.0.0.

Public Member Functions inherited from NXOpen::Display::BoundedGridBuilder
bool	Associative ()
	Returns the associative Created in NX6.0.0.

bool	GetCornerPoints (NXOpen::Point3d point1, NXOpen::Point3d point2, NXOpen::Point3d point3, NXOpen::Point3d point4)
	Gets corner points of the grid.

NXOpen::Display::BoundedGridBuilder::LabelReferenceType	LabelReference ()
	Returns the label reference Created in NX6.0.0.

NXOpen::Point3d	LocalOrigin ()
	Returns the local origin Created in NX6.0.0.

void	SaveCurves (const NXString &groupName)
	Creates curves by intersecting the bounded grid with all bodies in the part of the grid object.

void	SaveCurves (const char *groupName)
	Creates curves by intersecting the bounded grid with all bodies in the part of the grid object.

NXOpen::Display::SectionCurveSettingsBuilder *	SectionCurveSettings ()
	Returns the curve settings builder Created in NX6.0.0.

void	SetAssociative (bool associative)
	Sets the associative Created in NX6.0.0.

bool	SetCornerPoints (const NXOpen::Point3d &point1, const NXOpen::Point3d &point2, const NXOpen::Point3d &point3, const NXOpen::Point3d &point4)
	Sets corner points of the grid.

void	SetLabelReference (NXOpen::Display::BoundedGridBuilder::LabelReferenceType labelReference)
	Sets the label reference Created in NX6.0.0.

void	SetLocalOrigin (const NXOpen::Point3d &localOrigin)
	Sets the local origin Created in NX6.0.0.

void	SetShowLabel (NXOpen::Display::BoundedGridBuilder::ShowLabelType showLabelType)
	Sets the show labels Created in NX6.0.0.

NXOpen::Display::BoundedGridBuilder::ShowLabelType	ShowLabel ()
	Returns the show labels Created in NX6.0.0.

Public Member Functions inherited from NXOpen::Display::GridBuilder
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 datum plane grid Display::DatumPlaneGrid to a datum plane.

 <br> To create a new instance of this class, use @link Display::GridCollection::CreateDatumPlaneGridBuilder  Display::GridCollection::CreateDatumPlaneGridBuilder @endlink  <br>

Default values.

Property

Value

Associative

1

GridOrientation

Custom

LabelReference

Local

MajorLineSpacing

100 (millimeters part), 1 (inches part)

MajorLineStyle

Solid

MajorLineWeight

Normal

MinorLineStyle

Dashed

MinorLineWeight

Thin

MinorLinesPerMajor

1

Show

1

ShowLabel

Always

ShowMajorLines

1

ShowOnTop

0

SnapPointsPerMinor

1

SnapToGrid

0

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Display::DatumPlaneGridBuilder::GridOrientationType

Specifies grid orientation option to be used for grid display.

Enumerator:

GridOrientationTypeFromDatumPlane	Grid display matches datum plane display.
GridOrientationTypeCustom	Grid size, location, and orientation can be customized using the manipulator controls.

Member Function Documentation

std::vector<NXOpen::DatumPlane *> NXOpen::Display::DatumPlaneGridBuilder::GetDatumPlanes ( )

Get the list of datum planes.

Returns: datum plane list
Created in NX6.0.0.

License requirements : None

NXOpen::Display::DatumPlaneGridBuilder::GridOrientationType NXOpen::Display::DatumPlaneGridBuilder::GridOrientation ( )

Returns the grid orientation
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::DatumPlaneGridBuilder::SetDatumPlanes ( const std::vector< NXOpen::DatumPlane * > & datumPlanes )

Set the list of datum planes.

When editing an existing datum plane grid, only a single datum plane may be set and it must meet the following conditions:

one that currently does not have a grid associated to it
one that matches Display::DatumPlaneGridBuilder::GetDatumPlanes

Created in NX6.0.0.

License requirements : None

Parameters

datumPlanes datum plane list

void NXOpen::Display::DatumPlaneGridBuilder::SetGridOrientation ( NXOpen::Display::DatumPlaneGridBuilder::GridOrientationType gridOrientation )

Sets the grid orientation
Created in NX6.0.0.

License requirements : None

Parameters

gridOrientation gridorientation

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

Display_DatumPlaneGridBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation