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

Represents an Axis class. More...

Inheritance diagram for NXOpen::Axis:
NXOpen::SmartObject NXOpen::DisplayableObject NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

List of all members.

Public Types

enum  Types { TypesNonAssociative, TypesPointAndDirection, TypesOther }
 Defines types of axes based on their associativity. More...

Public Member Functions

NXOpen::DirectionDirection ()
 Returns the direction that the axis points for an axis with type Axis::TypesPointAndDirection .
NXOpen::Vector3d DirectionVector ()
 Returns the direction vector.
NXOpen::Point3d Origin ()
 Returns the origin.
NXOpen::PointPoint ()
 Returns the point that defines the origin of the axis for an axis with type Axis::TypesPointAndDirection .
void SetDirection (NXOpen::Direction *direction)
 Sets the direction that the axis points for an axis with type Axis::TypesPointAndDirection .
void SetDirectionVector (const NXOpen::Vector3d &vector)
 Sets the direction vector for a non-associative axis.
void SetOrigin (const NXOpen::Point3d &origin)
 Sets the origin for a non-associative axis.
void SetPoint (NXOpen::Point *point)
 Sets the point that defines the origin of the axis for an axis with type Axis::TypesPointAndDirection .
NXOpen::Axis::Types Type ()
 Returns the associativity type for the axis
Created in NX5.0.0.

Detailed Description

Represents an Axis class.


To create a new instance of this class, use AxisCollection::CreateAxis

Created in NX3.0.1.


Member Enumeration Documentation

Defines types of axes based on their associativity.

Enumerator:
TypesNonAssociative 

non-associative

TypesPointAndDirection 

the axis is defined by a Point and Direction

TypesOther 

the type is not one of the other enumerated types


Member Function Documentation

Returns the direction that the axis points for an axis with type Axis::TypesPointAndDirection .

An exception is thrown if the axis type is not Axis::TypesPointAndDirection ,


Created in NX3.0.1.

License requirements : None

Returns the direction vector.


Created in NX5.0.0.

License requirements : None

Returns the origin.


Created in NX5.0.0.

License requirements : None

Returns the point that defines the origin of the axis for an axis with type Axis::TypesPointAndDirection .

An exception is thrown if the axis type is not Axis::TypesPointAndDirection , If the axis type is point and direction and the point is not specified, the point is inferred from the direction.


Created in NX3.0.1.

License requirements : None

Sets the direction that the axis points for an axis with type Axis::TypesPointAndDirection .

An exception is thrown if the axis type is not Axis::TypesPointAndDirection ,


Created in NX3.0.1.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
directionThis parameter may not be NULL.

Sets the direction vector for a non-associative axis.

This method does nothing if the axis is associative
Created in NX5.0.0.

License requirements : None

Parameters:
vectorvector
void NXOpen::Axis::SetOrigin ( const NXOpen::Point3d origin)

Sets the origin for a non-associative axis.

This method does nothing if the axis is associative
Created in NX5.0.0.

License requirements : None

Parameters:
originorigin

Sets the point that defines the origin of the axis for an axis with type Axis::TypesPointAndDirection .

An exception is thrown if the axis type is not Axis::TypesPointAndDirection , If the axis type is point and direction and the point is not specified, the point is inferred from the direction.


Created in NX3.0.1.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
pointpoint

Returns the associativity type for the axis
Created in NX5.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.