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

Represents the builder for creating a bounded grid 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

List of all members.

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 Member Functions

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.
NXOpen::Display::SectionCurveSettingsBuilderSectionCurveSettings ()
 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.

Detailed Description

Represents the builder for creating a bounded grid 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

Returns the associative
Created in NX6.0.0.



License requirements : None

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

Returns the label reference
Created in NX6.0.0.



License requirements : None

Returns the local origin
Created in NX6.0.0.



License requirements : None

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.
NOTE: The full Unicode character set is not supported for this parameter.

Returns the curve settings builder
Created in NX6.0.0.



License requirements : None

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

Sets the label reference
Created in NX6.0.0.



License requirements : None

Parameters:
labelReferencelabelreference

Sets the local origin
Created in NX6.0.0.



License requirements : None

Parameters:
localOriginLabel origin

Sets the show labels
Created in NX6.0.0.



License requirements : None

Parameters:
showLabelTypeshowlabeltype

Returns the show labels
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.