NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Display::BoundedGridBuilder Class Reference

Represents the builder for creating a bounded grid NXOpen::Display::BoundedGrid . More...

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

Public Types

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, LineWeightTypeOne,
  LineWeightTypeTwo, LineWeightTypeThree, LineWeightTypeFour, LineWeightTypeFive,
  LineWeightTypeSix, LineWeightTypeSeven, LineWeightTypeEight, LineWeightTypeNine
}
 Specifies line weight to be used for major and minor lines of the grid. More...
 

Public Member Functions

bool Associative ()
 Returns the associative
Created in NX6.0.0. More...
 
bool GetCornerPoints (NXOpen::Point3d *point1, NXOpen::Point3d *point2, NXOpen::Point3d *point3, NXOpen::Point3d *point4)
 Gets corner points of the grid. More...
 
NXOpen::Display::BoundedGridBuilder::LabelReferenceType LabelReference ()
 Returns the label reference
Created in NX6.0.0. More...
 
NXOpen::Point3d LocalOrigin ()
 Returns the local origin
Created in NX6.0.0. More...
 
void SaveCurves (const NXString &groupName)
 Creates curves by intersecting the bounded grid with all bodies in the part of the grid object. More...
 
void SaveCurves (const char *groupName)
 Creates curves by intersecting the bounded grid with all bodies in the part of the grid object. More...
 
NXOpen::Display::SectionCurveSettingsBuilderSectionCurveSettings ()
 Returns the curve settings builder
Created in NX6.0.0. More...
 
void SetAssociative (bool associative)
 Sets the associative
Created in NX6.0.0. More...
 
bool SetCornerPoints (const NXOpen::Point3d &point1, const NXOpen::Point3d &point2, const NXOpen::Point3d &point3, const NXOpen::Point3d &point4)
 Sets corner points of the grid. More...
 
void SetLabelReference (NXOpen::Display::BoundedGridBuilder::LabelReferenceType labelReference)
 Sets the label reference
Created in NX6.0.0. More...
 
void SetLocalOrigin (const NXOpen::Point3d &localOrigin)
 Sets the local origin
Created in NX6.0.0. More...
 
void SetShowLabel (NXOpen::Display::BoundedGridBuilder::ShowLabelType showLabelType)
 Sets the show labels
Created in NX6.0.0. More...
 
NXOpen::Display::BoundedGridBuilder::ShowLabelType ShowLabel ()
 Returns the show labels
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Display::GridBuilder
void InheritSettings (NXOpen::Display::Grid *grid)
 Inherits the settings from the specified grid. More...
 
NXOpen::NXColorLineColor ()
 Returns the line color
Created in NX6.0.0. More...
 
double MajorLineSpacing ()
 Returns the major line spacing
Created in NX6.0.0. More...
 
NXOpen::Display::GridBuilder::LineStyleType MajorLineStyle ()
 Returns the major line style
Created in NX6.0.0. More...
 
NXOpen::Display::GridBuilder::LineWeightType MajorLineWeight ()
 Returns the major line weight
Created in NX6.0.0. More...
 
int MinorLinesPerMajor ()
 Returns the minor lines per major
Created in NX6.0.0. More...
 
NXOpen::Display::GridBuilder::LineStyleType MinorLineStyle ()
 Returns the minor line style
Created in NX6.0.0. More...
 
NXOpen::Display::GridBuilder::LineWeightType MinorLineWeight ()
 Returns the minor line weight
Created in NX6.0.0. More...
 
void SetLineColor (NXOpen::NXColor *lineColor)
 Sets the line color
Created in NX6.0.0. More...
 
void SetMajorLineSpacing (double majorLineSpacing)
 Sets the major line spacing
Created in NX6.0.0. More...
 
void SetMajorLineStyle (NXOpen::Display::GridBuilder::LineStyleType majorLineStyle)
 Sets the major line style
Created in NX6.0.0. More...
 
void SetMajorLineWeight (NXOpen::Display::GridBuilder::LineWeightType majorLineWeight)
 Sets the major line weight
Created in NX6.0.0. More...
 
void SetMinorLinesPerMajor (int minorLinesPerMajor)
 Sets the minor lines per major
Created in NX6.0.0. More...
 
void SetMinorLineStyle (NXOpen::Display::GridBuilder::LineStyleType minorLineStyle)
 Sets the minor line style
Created in NX6.0.0. More...
 
void SetMinorLineWeight (NXOpen::Display::GridBuilder::LineWeightType minorLineWeight)
 Sets the minor line weight
Created in NX6.0.0. More...
 
void SetShow (bool show)
 Sets the show
Created in NX6.0.0. More...
 
void SetShowMajorLines (bool showMajorLines)
 Sets the show major lines
Created in NX6.0.0. More...
 
void SetShowOnTop (bool showOnTop)
 Sets the show on top
Created in NX6.0.0. More...
 
void SetSnapPointsPerMinor (int snapPointsPerMinor)
 Sets the snap points per minor
Created in NX6.0.0. More...
 
void SetSnapToGrid (bool snapToGrid)
 Sets the snap to grid
Created in NX6.0.0. More...
 
bool Show ()
 Returns the show
Created in NX6.0.0. More...
 
bool ShowMajorLines ()
 Returns the show major lines
Created in NX6.0.0. More...
 
bool ShowOnTop ()
 Returns the show on top
Created in NX6.0.0. More...
 
int SnapPointsPerMinor ()
 Returns the snap points per minor
Created in NX6.0.0. More...
 
bool SnapToGrid ()
 Returns the snap to grid
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the builder for creating a bounded grid NXOpen::Display::BoundedGrid .


This is an abstract class, and cannot be instantiated.
Default values.

Property Value

SectionCurveSettings.ColorOption

Any

SectionCurveSettings.Show

false


Created in NX6.0.0.

Member Enumeration Documentation

Specifies label reference.

Enumerator
LabelReferenceTypeLocal 

Use local grid origin to determine grid line offset labels.

LabelReferenceTypeWcs 

Use projection of WCS origin on the grid plane to determine grid line offset labels.

LabelReferenceTypeAbsolute 

Use projection of absolute origin on the grid plane to determine grid line offset labels.

Specifies label option to be used for grid label display.

Enumerator
ShowLabelTypeAlways 

Always show label.

ShowLabelTypeParalleltoView 

Show labels when grid orientation is aligned with the view orientation.

ShowLabelTypeNone 

Never show labels.

Member Function Documentation

bool NXOpen::Display::BoundedGridBuilder::Associative ( )

Returns the associative
Created in NX6.0.0.



License requirements : None

bool NXOpen::Display::BoundedGridBuilder::GetCornerPoints ( NXOpen::Point3d point1,
NXOpen::Point3d point2,
NXOpen::Point3d point3,
NXOpen::Point3d point4 
)

Gets corner points of the grid.

Returns
Flag indicating whether the corner points are valid
Created in NX6.0.0.

License requirements : None
Parameters
point1First corner point
point2Second corner point
point3Third corner point
point4Fourth corner point
NXOpen::Display::BoundedGridBuilder::LabelReferenceType NXOpen::Display::BoundedGridBuilder::LabelReference ( )

Returns the label reference
Created in NX6.0.0.



License requirements : None

NXOpen::Point3d NXOpen::Display::BoundedGridBuilder::LocalOrigin ( )

Returns the local origin
Created in NX6.0.0.



License requirements : None

void NXOpen::Display::BoundedGridBuilder::SaveCurves ( const NXString groupName)

Creates curves by intersecting the bounded grid with all bodies in the part of the grid object.

The bodies that are visible in the work view are intersected. The curves are added to the group created with the specified name. The group is displayed in the part navigator. The curves are created in the work part. These curves are not associated with the grid. These are just snapshot curves that can be used for modeling purposes. If the customer default "Load Solids/Sheets when Saving Section Curves" is enabled, the Save Copy of Section Curves command in the datum plane grid dialog will cause solid/sheet bodies to be loaded into memory for any visible lightweight bodies on the section plane. This may increase the time and memory used by the operation, but will ensure fully accurate section curves.


Created in NX6.0.0.

License requirements : None

Parameters
groupNameName of the group containing curves. If NULL, a default name will be used.
void NXOpen::Display::BoundedGridBuilder::SaveCurves ( const char *  groupName)

Creates curves by intersecting the bounded grid with all bodies in the part of the grid object.

The bodies that are visible in the work view are intersected. The curves are added to the group created with the specified name. The group is displayed in the part navigator. The curves are created in the work part. These curves are not associated with the grid. These are just snapshot curves that can be used for modeling purposes. If the customer default "Load Solids/Sheets when Saving Section Curves" is enabled, the Save Copy of Section Curves command in the datum plane grid dialog will cause solid/sheet bodies to be loaded into memory for any visible lightweight bodies on the section plane. This may increase the time and memory used by the operation, but will ensure fully accurate section curves.


Created in NX6.0.0.

License requirements : None

Parameters
groupNameName of the group containing curves. If NULL, a default name will be used.
NXOpen::Display::SectionCurveSettingsBuilder* NXOpen::Display::BoundedGridBuilder::SectionCurveSettings ( )

Returns the curve settings builder
Created in NX6.0.0.



License requirements : None

void NXOpen::Display::BoundedGridBuilder::SetAssociative ( bool  associative)

Sets the associative
Created in NX6.0.0.



License requirements : None

Parameters
associativeassociative
bool NXOpen::Display::BoundedGridBuilder::SetCornerPoints ( const NXOpen::Point3d point1,
const NXOpen::Point3d point2,
const NXOpen::Point3d point3,
const NXOpen::Point3d point4 
)

Sets corner points of the grid.

Returns
Flag indicating whether the corner points are valid
Created in NX6.0.0.

License requirements : None
Parameters
point1First corner point
point2Second corner point
point3Third corner point
point4Fourth corner point
void NXOpen::Display::BoundedGridBuilder::SetLabelReference ( NXOpen::Display::BoundedGridBuilder::LabelReferenceType  labelReference)

Sets the label reference
Created in NX6.0.0.



License requirements : None

Parameters
labelReferencelabelreference
void NXOpen::Display::BoundedGridBuilder::SetLocalOrigin ( const NXOpen::Point3d localOrigin)

Sets the local origin
Created in NX6.0.0.



License requirements : None

Parameters
localOriginLabel origin
void NXOpen::Display::BoundedGridBuilder::SetShowLabel ( NXOpen::Display::BoundedGridBuilder::ShowLabelType  showLabelType)

Sets the show labels
Created in NX6.0.0.



License requirements : None

Parameters
showLabelTypeshowlabeltype
NXOpen::Display::BoundedGridBuilder::ShowLabelType NXOpen::Display::BoundedGridBuilder::ShowLabel ( )

Returns the show labels
Created in NX6.0.0.



License requirements : None


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