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

Represents the World Coordinate System. More...

List of all members.

Public Types

enum  Axis { AxisXAxis = 1, AxisYAxis, AxisZAxis }
 Specifies the X, Y, or Z axis. More...

Public Member Functions

NXOpen::CartesianCoordinateSystemCoordinateSystem ()
 Returns the CartesianCoordinateSystem associated with the WCS
Created in NX3.0.0.
NXOpen::Point3d Origin ()
 Returns the origin of the WCS
Created in NX3.0.0.
void Rotate (NXOpen::WCS::Axis rotationAxis, double angle)
 Rotates the WCS about the specified axis.
NXOpen::CartesianCoordinateSystemSave ()
 Saves the WCS.
NXOpen::CoordinateSystemSetCoordinateSystem (NXOpen::CoordinateSystem *newCs)
 Changes the coordinate system of the WCS to a new coordinate system.
NXOpen::CartesianCoordinateSystemSetCoordinateSystem (NXOpen::CartesianCoordinateSystem *newCs)
 Changes the coordinate system of the WCS to a new coordinate system.
NXOpen::CartesianCoordinateSystemSetCoordinateSystemCartesianAtCsys (NXOpen::CartesianCoordinateSystem *newCs)
 Creates a WCS at a new coordinate system.
void SetOrigin (const NXOpen::Point3d &origin)
 Sets the origin of the WCS
Created in NX3.0.0.
void SetOriginAndMatrix (const NXOpen::Point3d &origin, const NXOpen::Matrix3x3 &matrix)
 Sets the origin and orientation matrix of the WCS.
void SetVisibility (bool isVisible)
 Sets the visibility of the WCS
Created in NX3.0.0.
tag_t Tag () const
 Returns the tag of this object.
bool Visibility ()
 Returns the visibility of the WCS
Created in NX3.0.0.

Detailed Description

Represents the World Coordinate System.


The origin coordinates and orientation matrix are always relative to the absolute coordinate system.

In order to use any of the WCS methods, the display part must be the part that owns the WCS.

To obtain an instance of this class, refer to BasePart

Created in NX3.0.0.


Member Enumeration Documentation

Specifies the X, Y, or Z axis.

Enumerator:
AxisYAxis 

yaxis

AxisZAxis 

zaxis


Member Function Documentation

Returns the CartesianCoordinateSystem associated with the WCS
Created in NX3.0.0.



License requirements : None

Returns the origin of the WCS
Created in NX3.0.0.



License requirements : None

void NXOpen::WCS::Rotate ( NXOpen::WCS::Axis  rotationAxis,
double  angle 
)

Rotates the WCS about the specified axis.

The angle is in degrees.
Created in NX3.0.0.

License requirements : None

Parameters:
rotationAxisWhich WCS axis to rotate about (X, Y, or Z)
angleAngle of rotation in degrees

Saves the WCS.

A new cartesian coordinate system is created in the work part, even though the WCS is owned by the display part.

Returns:
The saved coordinate system
Created in NX3.0.0.

License requirements : None

Changes the coordinate system of the WCS to a new coordinate system.

The return value is the old coordinate system.
This method is deprecated. Use the version of this method that takes a CartesianCoordinateSystem as input.

Returns:
The old coordinate system for the WCS
Deprecated:
Deprecated in NX4.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
newCsThe new coordinate system for the WCS

Changes the coordinate system of the WCS to a new coordinate system.

The return value is the old coordinate system.

Returns:
The old coordinate system for the WCS
Created in NX4.0.0.

License requirements : None
Parameters:
newCsThe new coordinate system for the WCS

Creates a WCS at a new coordinate system.

The return value is the old coordinate system of wcs.

Returns:
The old coordinate system for the WCS
Created in NX7.5.0.

License requirements : None
Parameters:
newCsNew coordinate system location for the WCS
void NXOpen::WCS::SetOrigin ( const NXOpen::Point3d origin)

Sets the origin of the WCS
Created in NX3.0.0.



License requirements : None

Parameters:
originorigin
void NXOpen::WCS::SetOriginAndMatrix ( const NXOpen::Point3d origin,
const NXOpen::Matrix3x3 matrix 
)

Sets the origin and orientation matrix of the WCS.


Created in NX3.0.0.

License requirements : None

Parameters:
originOrigin relative to the absolute coordinate system
matrixOrientation relative to the absolute coordinate system. Must be orthonormal.
void NXOpen::WCS::SetVisibility ( bool  isVisible)

Sets the visibility of the WCS
Created in NX3.0.0.



License requirements : None

Parameters:
isVisibleis visible
tag_t NXOpen::WCS::Tag ( ) const

Returns the tag of this object.

Returns the visibility of the WCS
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.