NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
NXOpen::Preferences::WorkPlane Class Reference

Represents the set of WorkPlanePreferences preferences applicable to part. More...

Inheritance diagram for NXOpen::Preferences::WorkPlane:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Classes

struct  GridSize
 Grid size parameters. More...
struct  NonuniformGridSize
 Nonuniform grid size parameters. More...
struct  PolarGridSize
 Polar grid size parameters. More...

Public Types

enum  Grid { GridPolar, GridRectangular }
 Describes whether the Grid type selected is Polar or Rectangular. More...

Public Member Functions

NXOpen::Preferences::WorkPlane::PolarGridSize GetPolarGridSize ()
 Query the polar grid size parameters.
NXOpen::Preferences::WorkPlane::NonuniformGridSize GetRectangularNonuniformGridSize ()
 Query the rectangular nonuniform grid size parameters.
NXOpen::Preferences::WorkPlane::GridSize GetRectangularUniformGridSize ()
 Query the rectangular uniform grid size parameters.
int GridColor ()
 Returns the grid color.
int GridEmphasisAngularSpacing ()
 Returns the grid emphasis every angular spacing.
int GridEmphasisEveryXcSpacing ()
 Returns the emphasis every XC spacing.
int GridEmphasisEveryYcSpacing ()
 Returns the emphasis every YC spacing.
int GridEmphasisRadialSpacing ()
 Returns the grid emphasis every radial spacing

bool GridIsNonUniform ()
 Returns the grid non uniform flag.
int GridLineEveryAngularSpacing ()
 Returns the grid line every angular spacing.
int GridLineEveryRadialSpacing ()
 Returns the grid line every radial spacing

int GridLineEveryXcSpacing ()
 Returns the grid line XC spacing.
int GridLineEveryYcSpacing ()
 Returns the grid line every YC spacing.
bool GridOnTop ()
 Returns the grid on top flag.
NXOpen::Preferences::WorkPlane::Grid GridType ()
 Returns the grid type.
double GridUnitAngularSpacing ()
 Returns the grid unit angular spacing.
double GridUnitRadialSpacing ()
 Returns the grid unit radial spacing.This value is the number of inches or millimeters between successive concentric circles of grid points that are centered at the WCS origin.
double GridUnitXcSpacing ()
 Returns the grid unit XC spacing.
double GridUnitYcSpacing ()
 Returns the grid unit YC spacing.
bool PolarGridEmphasis ()
 Returns the emphasis flag for polar grid

bool PolarShowMajorLines ()
 Returns the show major lines flag for polar grid
Created in NX6.0.0.
bool RectangularGridEmphasis ()
 Returns the emphasis flag for rectangular grid

bool RectangularShowMajorLines ()
 Returns the show major lines flag for rectangular grid
Created in NX6.0.0.
void SetGridColor (int gridColor)
 Sets the grid color.
void SetGridEmphasisAngularSpacing (int gridEmphasisAngularSpacing)
 Sets the grid emphasis every angular spacing.
void SetGridEmphasisEveryXcSpacing (int gridEmphasisEveryX)
 Sets the emphasis every XC spacing.
void SetGridEmphasisEveryYcSpacing (int gridEmphasisEveryY)
 Sets the emphasis every YC spacing.
void SetGridEmphasisRadialSpacing (int gridEmphasisRadialSpacing)
 Sets the grid emphasis every radial spacing

void SetGridIsNonUniform (bool gridIsNonUniform)
 Sets the grid non uniform flag.
void SetGridLineEveryAngularSpacing (int gridLineEveryAngularSpacing)
 Sets the grid line every angular spacing.
void SetGridLineEveryRadialSpacing (int gridLineEveryRadialSpacing)
 Sets the grid line every radial spacing

void SetGridLineEveryXcSpacing (int gridLineEveryX)
 Sets the grid line XC spacing.
void SetGridLineEveryYcSpacing (int gridLineEveryY)
 Sets the grid line every YC spacing.
void SetGridOnTop (bool gridOnTop)
 Sets the grid on top flag.
void SetGridType (NXOpen::Preferences::WorkPlane::Grid gridType)
 Sets the grid type.
void SetGridUnitAngularSpacing (double gridUnitAngularSpacing)
 Sets the grid unit angular spacing.
void SetGridUnitRadialSpacing (double gridUnitRadialSpacing)
 Sets the grid unit radial spacing.This value is the number of inches or millimeters between successive concentric circles of grid points that are centered at the WCS origin.
void SetGridUnitXcSpacing (double gridUnitXcSpacing)
 Sets the grid unit XC spacing.
void SetGridUnitYcSpacing (double gridUnitYcSpacing)
 Sets the grid unit YC spacing.
void SetPolarGridEmphasis (bool isPolarGridEmphasisOn)
 Sets the emphasis flag for polar grid

void SetPolarGridSize (const NXOpen::Preferences::WorkPlane::PolarGridSize &polarGridSize)
 Set the polar grid size parameters.
void SetPolarShowMajorLines (bool polarShowMajorLines)
 Sets the show major lines flag for polar grid
Created in NX6.0.0.
void SetRectangularGridEmphasis (bool rectangularGridEmphasis)
 Sets the emphasis flag for rectangular grid

void SetRectangularNonuniformGridSize (const NXOpen::Preferences::WorkPlane::NonuniformGridSize &nonuniformGridSize)
 Set the rectangular nonuniform grid size parameters.
void SetRectangularShowMajorLines (bool rectangularShowMajorLines)
 Sets the show major lines flag for rectangular grid
Created in NX6.0.0.
void SetRectangularUniformGridSize (const NXOpen::Preferences::WorkPlane::GridSize &gridSize)
 Set the rectangular uniform grid size parameters.
void SetShowGrid (bool showGrid)
 Sets the show and hide grid flag.
void SetShowLabels (bool showLabels)
 Sets the show and hide grid labels flag.
void SetSnapToGrid (bool snapToGrid)
 Sets the snap to grid flag.
bool ShowGrid ()
 Returns the show and hide grid flag.
bool ShowLabels ()
 Returns the show and hide grid labels flag.
bool SnapToGrid ()
 Returns the snap to grid flag.

Detailed Description

Represents the set of WorkPlanePreferences preferences applicable to part.

Sets parameters for the Graphics Window grid and the Work Plane Emphasis mode.
An instance of this class can be obtained using Preferences::SessionPreferences::WorkPlane or Preferences::PartPreferences::Workplane

Created in NX3.0.0.


Member Enumeration Documentation

Describes whether the Grid type selected is Polar or Rectangular.

Enumerator:
GridPolar 

Polar Grid.

GridRectangular 

Rectangular Grid.


Member Function Documentation

Query the polar grid size parameters.

Returns:

Created in NX6.0.0.

License requirements : None

Query the rectangular nonuniform grid size parameters.

Returns:

Created in NX6.0.0.

License requirements : None

Query the rectangular uniform grid size parameters.

Returns:

Created in NX6.0.0.

License requirements : None

Returns the grid color.

Specifies the color of grid.
Created in NX3.0.0.

License requirements : None

Returns the grid emphasis every angular spacing.

Draws an emphasis line every n grid lines

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the emphasis every XC spacing.

Places an emphasis (solid) line every n lines

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the emphasis every YC spacing.

Places an emphasis (solid) line every n lines

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the grid emphasis every radial spacing

Deprecated:
Deprecated in NX6.0.0.



Created in NX3.0.0.

License requirements : None

Returns the grid non uniform flag.

If true grid is non uniform. A uniform grid has the same spacing in X and Y. A non-uniform grid allows for different spacing in X and Y.
Created in NX3.0.0.

License requirements : None

Returns the grid line every angular spacing.


Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the grid line every radial spacing

Deprecated:
Deprecated in NX6.0.0.



Created in NX3.0.0.

License requirements : None

Returns the grid line XC spacing.


Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the grid line every YC spacing.

Draws an emphasis line every n grid lines.

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the grid on top flag.

If true displays the grid on top of other graphics in the scene.
Created in NX6.0.0.

License requirements : None

Returns the grid type.

It may be polar or rectangular
Created in NX3.0.0.

License requirements : None

Returns the grid unit angular spacing.

This is the number of degrees between successive rays of grid points that emanate from the WCS origin

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the grid unit radial spacing.This value is the number of inches or millimeters between successive concentric circles of grid points that are centered at the WCS origin.


Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the grid unit XC spacing.

Determines where the system draws grid lines.

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the grid unit YC spacing.

Determines where the system draws grid lines.

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the emphasis flag for polar grid

Deprecated:
Deprecated in NX6.0.0.



Created in NX3.0.0.

License requirements : None

Returns the show major lines flag for polar grid
Created in NX6.0.0.



License requirements : None

Returns the emphasis flag for rectangular grid

Deprecated:
Deprecated in NX6.0.0.



Created in NX3.0.0.

License requirements : None

Returns the show major lines flag for rectangular grid
Created in NX6.0.0.



License requirements : None

Sets the grid color.

Specifies the color of grid.
Created in NX3.0.0.

License requirements : None

Parameters:
gridColorgrid color
void NXOpen::Preferences::WorkPlane::SetGridEmphasisAngularSpacing ( int  gridEmphasisAngularSpacing)

Sets the grid emphasis every angular spacing.

Draws an emphasis line every n grid lines

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
gridEmphasisAngularSpacinggrid emphasis angular spacing

Sets the emphasis every XC spacing.

Places an emphasis (solid) line every n lines

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
gridEmphasisEveryXgrid emphasis every x

Sets the emphasis every YC spacing.

Places an emphasis (solid) line every n lines

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
gridEmphasisEveryYgrid emphasis every y
void NXOpen::Preferences::WorkPlane::SetGridEmphasisRadialSpacing ( int  gridEmphasisRadialSpacing)

Sets the grid emphasis every radial spacing

Deprecated:
Deprecated in NX6.0.0.



Created in NX3.0.0.

License requirements : None

Parameters:
gridEmphasisRadialSpacinggrid emphasis radial spacing
void NXOpen::Preferences::WorkPlane::SetGridIsNonUniform ( bool  gridIsNonUniform)

Sets the grid non uniform flag.

If true grid is non uniform. A uniform grid has the same spacing in X and Y. A non-uniform grid allows for different spacing in X and Y.
Created in NX3.0.0.

License requirements : None

Parameters:
gridIsNonUniformgrid is non uniform
void NXOpen::Preferences::WorkPlane::SetGridLineEveryAngularSpacing ( int  gridLineEveryAngularSpacing)

Sets the grid line every angular spacing.


Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
gridLineEveryAngularSpacinggrid line every angular spacing
void NXOpen::Preferences::WorkPlane::SetGridLineEveryRadialSpacing ( int  gridLineEveryRadialSpacing)

Sets the grid line every radial spacing

Deprecated:
Deprecated in NX6.0.0.



Created in NX3.0.0.

License requirements : None

Parameters:
gridLineEveryRadialSpacinggrid line every radial spacing

Sets the grid line XC spacing.


Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
gridLineEveryXgrid line every x

Sets the grid line every YC spacing.

Draws an emphasis line every n grid lines.

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
gridLineEveryYgrid line every y

Sets the grid on top flag.

If true displays the grid on top of other graphics in the scene.
Created in NX6.0.0.

License requirements : None

Parameters:
gridOnTopgrid on top

Sets the grid type.

It may be polar or rectangular
Created in NX3.0.0.

License requirements : None

Parameters:
gridTypegrid type
void NXOpen::Preferences::WorkPlane::SetGridUnitAngularSpacing ( double  gridUnitAngularSpacing)

Sets the grid unit angular spacing.

This is the number of degrees between successive rays of grid points that emanate from the WCS origin

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
gridUnitAngularSpacinggrid unit angular spacing
void NXOpen::Preferences::WorkPlane::SetGridUnitRadialSpacing ( double  gridUnitRadialSpacing)

Sets the grid unit radial spacing.This value is the number of inches or millimeters between successive concentric circles of grid points that are centered at the WCS origin.


Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
gridUnitRadialSpacinggrid unit radial spacing
void NXOpen::Preferences::WorkPlane::SetGridUnitXcSpacing ( double  gridUnitXcSpacing)

Sets the grid unit XC spacing.

Determines where the system draws grid lines.

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
gridUnitXcSpacinggrid unit xc spacing
void NXOpen::Preferences::WorkPlane::SetGridUnitYcSpacing ( double  gridUnitYcSpacing)

Sets the grid unit YC spacing.

Determines where the system draws grid lines.

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
gridUnitYcSpacinggrid unit yc spacing
void NXOpen::Preferences::WorkPlane::SetPolarGridEmphasis ( bool  isPolarGridEmphasisOn)

Sets the emphasis flag for polar grid

Deprecated:
Deprecated in NX6.0.0.



Created in NX3.0.0.

License requirements : None

Parameters:
isPolarGridEmphasisOnispolargridemphasison

Set the polar grid size parameters.


Created in NX6.0.0.

License requirements : None

Parameters:
polarGridSizepolar grid size
void NXOpen::Preferences::WorkPlane::SetPolarShowMajorLines ( bool  polarShowMajorLines)

Sets the show major lines flag for polar grid
Created in NX6.0.0.



License requirements : None

Parameters:
polarShowMajorLinespolar show major lines
void NXOpen::Preferences::WorkPlane::SetRectangularGridEmphasis ( bool  rectangularGridEmphasis)

Sets the emphasis flag for rectangular grid

Deprecated:
Deprecated in NX6.0.0.



Created in NX3.0.0.

License requirements : None

Parameters:
rectangularGridEmphasisrectangular grid emphasis

Set the rectangular nonuniform grid size parameters.


Created in NX6.0.0.

License requirements : None

Parameters:
nonuniformGridSizenonuniform grid size
void NXOpen::Preferences::WorkPlane::SetRectangularShowMajorLines ( bool  rectangularShowMajorLines)

Sets the show major lines flag for rectangular grid
Created in NX6.0.0.



License requirements : None

Parameters:
rectangularShowMajorLinesrectangular show major lines

Set the rectangular uniform grid size parameters.


Created in NX6.0.0.

License requirements : None

Parameters:
gridSizegrid size

Sets the show and hide grid flag.

If true displays the grid pattern in the graphics window else hides
Created in NX3.0.0.

License requirements : None

Parameters:
showGridshow grid

Sets the show and hide grid labels flag.

If true displays the grid labels in the graphics window else hides
Created in NX5.0.0.

License requirements : None

Parameters:
showLabelsshow labels

Sets the snap to grid flag.

If true enables snapping (moves an indicated screen position point to the nearest grid point). Points snap to the grid even when Show Grid is off.
Created in NX3.0.0.

License requirements : None

Parameters:
snapToGridsnap to grid

Returns the show and hide grid flag.

If true displays the grid pattern in the graphics window else hides
Created in NX3.0.0.

License requirements : None

Returns the show and hide grid labels flag.

If true displays the grid labels in the graphics window else hides
Created in NX5.0.0.

License requirements : None

Returns the snap to grid flag.

If true enables snapping (moves an indicated screen position point to the nearest grid point). Points snap to the grid even when Show Grid is off.
Created in NX3.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.