NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Drawings::View2dOrientBuilder Class Reference

Represents the View 2D Orientation (Drawings.View2dOrientBuilder) More...

Inheritance diagram for NXOpen::Drawings::View2dOrientBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CustomMethod { CustomMethodAngles, CustomMethodVector }
 The custom orientation method. More...
 
enum  Type {
  TypeNone, TypeTop, TypeFront, TypeRight,
  TypeBack, TypeBottom, TypeLeft, TypeIso,
  TypeTri, TypeCustom
}
 The view orientation type. More...
 

Public Member Functions

NXOpen::Drawings::View2dOrientBuilder::CustomMethod CustomOrientationMethod ()
 Returns the custom orientation method
Created in NX6.0.0. More...
 
double CustomXAngle ()
 Returns the orientation angle around the X axis
Created in NX6.0.0. More...
 
double CustomYAngle ()
 Returns the orientation angle around the Y axis
Created in NX6.0.0. More...
 
double CustomZAngle ()
 Returns the orientation angle around the Z axis
Created in NX6.0.0. More...
 
double GetCustomNormalX ()
 Returns the X component of the custom view-normal vector. More...
 
double GetCustomNormalY ()
 Returns the Y component of the custom view-normal vector. More...
 
double GetCustomNormalZ ()
 Returns the Z component of the custom view-normal vector. More...
 
double GetCustomPrimaryX ()
 Returns the X component of the custom view-primary vector. More...
 
double GetCustomPrimaryY ()
 Returns the Y component of the custom view-primary vector. More...
 
double GetCustomPrimaryZ ()
 Returns the Z component of the custom view-primary vector. More...
 
bool GetInferredPrimary ()
 Returns the option to infer the direction view X vector in 3D space. More...
 
NXOpen::Drawings::View2dOrientBuilder::Type OrientationType ()
 Returns the orientation type
Created in NX6.0.0. More...
 
void SetCustomNormalX (double component)
 Sets the X component of the custom view-normal vector
Created in NX6.0.0. More...
 
void SetCustomNormalY (double component)
 Sets the Y component of the custom view-normal vector
Created in NX6.0.0. More...
 
void SetCustomNormalZ (double component)
 Sets the Z component of the custom view-normal vector
Created in NX6.0.0. More...
 
void SetCustomOrientationMethod (NXOpen::Drawings::View2dOrientBuilder::CustomMethod methd)
 Sets the custom orientation method
Created in NX6.0.0. More...
 
void SetCustomPrimaryX (double component)
 Sets the X component of the custom view-primary vector
Created in NX6.0.0. More...
 
void SetCustomPrimaryY (double component)
 Sets the Y component of the custom view-primary vector
Created in NX6.0.0. More...
 
void SetCustomPrimaryZ (double component)
 Sets the Z component of the custom view-primary vector
Created in NX6.0.0. More...
 
void SetCustomXAngle (double angle)
 Sets the orientation angle around the X axis
Created in NX6.0.0. More...
 
void SetCustomYAngle (double angle)
 Sets the orientation angle around the Y axis
Created in NX6.0.0. More...
 
void SetCustomZAngle (double angle)
 Sets the orientation angle around the Z axis
Created in NX6.0.0. More...
 
void SetInferredPrimary (bool inferred)
 Sets the option to infer the direction view X vector in 3D space
Created in NX6.0.0. More...
 
void SetOrientationType (NXOpen::Drawings::View2dOrientBuilder::Type type)
 Sets the orientation type
Created in NX6.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the View 2D Orientation (Drawings.View2dOrientBuilder)


Created in NX6.0.0.

Member Enumeration Documentation

The custom orientation method.

Enumerator
CustomMethodAngles 

axis rotations

CustomMethodVector 

cartesian vector

The view orientation type.

Enumerator
TypeNone 

not oriented

TypeTop 

top view

TypeFront 

front view

TypeRight 

right view

TypeBack 

back view

TypeBottom 

bottom view

TypeLeft 

left view

TypeIso 

isometric view

TypeTri 

trimetric view

TypeCustom 

custom method used

Member Function Documentation

NXOpen::Drawings::View2dOrientBuilder::CustomMethod NXOpen::Drawings::View2dOrientBuilder::CustomOrientationMethod ( )

Returns the custom orientation method
Created in NX6.0.0.



License requirements : None

double NXOpen::Drawings::View2dOrientBuilder::CustomXAngle ( )

Returns the orientation angle around the X axis
Created in NX6.0.0.



License requirements : None

double NXOpen::Drawings::View2dOrientBuilder::CustomYAngle ( )

Returns the orientation angle around the Y axis
Created in NX6.0.0.



License requirements : None

double NXOpen::Drawings::View2dOrientBuilder::CustomZAngle ( )

Returns the orientation angle around the Z axis
Created in NX6.0.0.



License requirements : None

double NXOpen::Drawings::View2dOrientBuilder::GetCustomNormalX ( )

Returns the X component of the custom view-normal vector.

Returns
returns the X component of view normal in global CS
Created in NX6.0.0.

License requirements : None
double NXOpen::Drawings::View2dOrientBuilder::GetCustomNormalY ( )

Returns the Y component of the custom view-normal vector.

Returns
returns the Y component of view normal in global CS
Created in NX6.0.0.

License requirements : None
double NXOpen::Drawings::View2dOrientBuilder::GetCustomNormalZ ( )

Returns the Z component of the custom view-normal vector.

Returns
returns the Z component of view normal in global CS
Created in NX6.0.0.

License requirements : None
double NXOpen::Drawings::View2dOrientBuilder::GetCustomPrimaryX ( )

Returns the X component of the custom view-primary vector.

Returns
returns the X component of view primary vector in global CS
Created in NX6.0.0.

License requirements : None
double NXOpen::Drawings::View2dOrientBuilder::GetCustomPrimaryY ( )

Returns the Y component of the custom view-primary vector.

Returns
returns the Y component of view primary vector in global CS
Created in NX6.0.0.

License requirements : None
double NXOpen::Drawings::View2dOrientBuilder::GetCustomPrimaryZ ( )

Returns the Z component of the custom view-primary vector.

Returns
returns the Z component of view primary vector in global CS
Created in NX6.0.0.

License requirements : None
bool NXOpen::Drawings::View2dOrientBuilder::GetInferredPrimary ( )

Returns the option to infer the direction view X vector in 3D space.

Returns
returns the inferred option
Created in NX6.0.0.

License requirements : None
NXOpen::Drawings::View2dOrientBuilder::Type NXOpen::Drawings::View2dOrientBuilder::OrientationType ( )

Returns the orientation type
Created in NX6.0.0.



License requirements : None

void NXOpen::Drawings::View2dOrientBuilder::SetCustomNormalX ( double  component)

Sets the X component of the custom view-normal vector
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
componentsets the the X component of view normal in global CS
void NXOpen::Drawings::View2dOrientBuilder::SetCustomNormalY ( double  component)

Sets the Y component of the custom view-normal vector
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
componentsets the the Y component of view normal in global CS
void NXOpen::Drawings::View2dOrientBuilder::SetCustomNormalZ ( double  component)

Sets the Z component of the custom view-normal vector
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
componentsets the the Z component of view normal in global CS
void NXOpen::Drawings::View2dOrientBuilder::SetCustomOrientationMethod ( NXOpen::Drawings::View2dOrientBuilder::CustomMethod  methd)

Sets the custom orientation method
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
methdsets the custom orientation method.
void NXOpen::Drawings::View2dOrientBuilder::SetCustomPrimaryX ( double  component)

Sets the X component of the custom view-primary vector
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
componentsets the the X component of view primary vector in global CS
void NXOpen::Drawings::View2dOrientBuilder::SetCustomPrimaryY ( double  component)

Sets the Y component of the custom view-primary vector
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
componentsets the the Y component of view primary vector in global CS
void NXOpen::Drawings::View2dOrientBuilder::SetCustomPrimaryZ ( double  component)

Sets the Z component of the custom view-primary vector
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
componentsets the the Z component of view primary vector in global CS
void NXOpen::Drawings::View2dOrientBuilder::SetCustomXAngle ( double  angle)

Sets the orientation angle around the X axis
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
anglesets the angle around X axis
void NXOpen::Drawings::View2dOrientBuilder::SetCustomYAngle ( double  angle)

Sets the orientation angle around the Y axis
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
anglesets the angle around Y axis
void NXOpen::Drawings::View2dOrientBuilder::SetCustomZAngle ( double  angle)

Sets the orientation angle around the Z axis
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
anglesets the angle around Z axis
void NXOpen::Drawings::View2dOrientBuilder::SetInferredPrimary ( bool  inferred)

Sets the option to infer the direction view X vector in 3D space
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
inferredsets the inferred option
void NXOpen::Drawings::View2dOrientBuilder::SetOrientationType ( NXOpen::Drawings::View2dOrientBuilder::Type  type)

Sets the orientation type
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
typesets the orientation type.
virtual bool NXOpen::Drawings::View2dOrientBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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