NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.WCS Class Reference

Represents the World Coordinate System. More...

Inheritance diagram for NXOpen.WCS:

Public Types

enum  Axis { XAxis = 1, YAxis, ZAxis }
 Specifies the X, Y, or Z axis More...
 

Public Member Functions

unsafe
NXOpen.CartesianCoordinateSystem 
Save ()
 Saves the WCS. More...
 
unsafe void SetOriginAndMatrix (NXOpen.Point3d origin, NXOpen.Matrix3x3 matrix)
 Sets the origin and orientation matrix of the WCS More...
 
unsafe void Rotate (NXOpen.WCS.Axis rotationAxis, double angle)
 Rotates the WCS about the specified axis. More...
 
unsafe
NXOpen.CartesianCoordinateSystem 
SetCoordinateSystem (NXOpen.CartesianCoordinateSystem newCs)
 Changes the coordinate system of the WCS to a new coordinate system. More...
 
unsafe
NXOpen.CartesianCoordinateSystem 
SetCoordinateSystemCartesianAtCsys (NXOpen.CartesianCoordinateSystem newCs)
 Creates a WCS at a new coordinate system. More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 
unsafe
NXOpen.CartesianCoordinateSystem 
CoordinateSystem [get]
 Returns the CartesianCoordinateSystem associated with the WCS More...
 
unsafe NXOpen.Point3d Origin [get, set]
 Returns or sets the origin of the WCS More...
 
unsafe bool Visibility [get, set]
 Returns or sets the visibility of the WCS More...
 

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 NXOpen.BasePart

Created in NX3.0.0

Member Enumeration Documentation

Specifies the X, Y, or Z axis

Enumerator
XAxis 
YAxis 
ZAxis 

Member Function Documentation

unsafe 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
unsafe NXOpen.CartesianCoordinateSystem NXOpen.WCS.Save ( )

Saves the WCS.

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

Created in NX3.0.0

License requirements: None.

Returns
The saved coordinate system
unsafe NXOpen.CartesianCoordinateSystem NXOpen.WCS.SetCoordinateSystem ( NXOpen.CartesianCoordinateSystem  newCs)

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

The return value is the old coordinate system. The old coordinate system will be displayed after the WCS is moved to the location of the new coordinate system.

Created in NX4.0.0

License requirements: None.

Parameters
newCsThe new coordinate system for the WCS
Returns
The old coordinate system for the WCS
unsafe NXOpen.CartesianCoordinateSystem NXOpen.WCS.SetCoordinateSystemCartesianAtCsys ( NXOpen.CartesianCoordinateSystem  newCs)

Creates a WCS at a new coordinate system.

The return value is the old coordinate system of wcs.

Created in NX7.5.0

License requirements: None.

Parameters
newCsNew coordinate system location for the WCS
Returns
The old coordinate system for the WCS
unsafe void NXOpen.WCS.SetOriginAndMatrix ( NXOpen.Point3d  origin,
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.

Property Documentation

unsafe NXOpen.CartesianCoordinateSystem NXOpen.WCS.CoordinateSystem
get

Returns the CartesianCoordinateSystem associated with the WCS

Created in NX3.0.0

License requirements: None.

unsafe NXOpen.Point3d NXOpen.WCS.Origin
getset

Returns or sets the origin of the WCS

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

Tag NXOpen.WCS.Tag
get

Returns the tag of this object.

unsafe bool NXOpen.WCS.Visibility
getset

Returns or sets the visibility of the WCS

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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