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

Represents a NXOpen::GeometricUtilities::SupportPlaneData
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::GeometricUtilities::SupportPlaneData:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  LockPlaneStatus {
  LockPlaneStatusNo, LockPlaneStatusAfterFirstConstraint, LockPlaneStatusAfterSecondConstraint, LockPlaneStatusAfterThirdConstraint,
  LockPlaneStatusAfterFirstAndSecondConstraint, LockPlaneStatusAfterFirstAndThirdConstraint, LockPlaneStatusAfterSecondAndThirdConstraint, LockPlaneStatusAfterAllConstraint,
  LockPlaneStatusLockExistingPlane, LockPlaneStatusCenterPointDirection
}
 Represents support plane lock status for associative basic curves. More...
 

Public Member Functions

NXOpen::DisplayableObjectExistingPlane ()
 Returns the existing face or plane
Created in NX5.0.0. More...
 
void SetExistingPlane (NXOpen::DisplayableObject *existingPlane)
 Sets the existing face or plane
Created in NX5.0.0. More...
 
void SetSupportPlane (NXOpen::Plane *supportPlane)
 Sets the support plane
Created in NX5.0.0. More...
 
void SetSupportPlaneLockStatus (NXOpen::GeometricUtilities::SupportPlaneData::LockPlaneStatus lockPlaneStatus)
 Sets the support plane lock status
Created in NX5.0.0. More...
 
void SetWorkView (NXOpen::View *workView)
 Sets the work view required when lock plane status is NXOpen::GeometricUtilities::SupportPlaneData::LockPlaneStatusAfterFirstConstraint
Created in NX5.0.0. More...
 
NXOpen::PlaneSupportPlane ()
 Returns the support plane
Created in NX5.0.0. More...
 
NXOpen::GeometricUtilities::SupportPlaneData::LockPlaneStatus SupportPlaneLockStatus ()
 Returns the support plane lock status
Created in NX5.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
NXOpen::ViewWorkView ()
 Returns the work view required when lock plane status is NXOpen::GeometricUtilities::SupportPlaneData::LockPlaneStatusAfterFirstConstraint
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::GeometricUtilities::SupportPlaneData
Created in NX5.0.0.


Member Enumeration Documentation

Represents support plane lock status for associative basic curves.

Enumerator
LockPlaneStatusNo 

No Lock.

LockPlaneStatusAfterFirstConstraint 

Lock after first constraint.

LockPlaneStatusAfterSecondConstraint 

Lock after second constraint.

LockPlaneStatusAfterThirdConstraint 

Lock after third constraint.

LockPlaneStatusAfterFirstAndSecondConstraint 

Lock after first and second constraint.

LockPlaneStatusAfterFirstAndThirdConstraint 

Lock after first and third constraint.

LockPlaneStatusAfterSecondAndThirdConstraint 

Lock after second and third constraint.

LockPlaneStatusAfterAllConstraint 

Lock after all constraint.

LockPlaneStatusLockExistingPlane 

Lock support plane using existing face or datum.

LockPlaneStatusCenterPointDirection 

Lock support plane using center point and direction, this option should be used for Center Radius Arc only.

Member Function Documentation

NXOpen::DisplayableObject* NXOpen::GeometricUtilities::SupportPlaneData::ExistingPlane ( )

Returns the existing face or plane
Created in NX5.0.0.



License requirements : None

void NXOpen::GeometricUtilities::SupportPlaneData::SetExistingPlane ( NXOpen::DisplayableObject existingPlane)

Sets the existing face or plane
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
existingPlaneexistingplane
void NXOpen::GeometricUtilities::SupportPlaneData::SetSupportPlane ( NXOpen::Plane supportPlane)

Sets the support plane
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
supportPlanesupportplane
void NXOpen::GeometricUtilities::SupportPlaneData::SetSupportPlaneLockStatus ( NXOpen::GeometricUtilities::SupportPlaneData::LockPlaneStatus  lockPlaneStatus)

Sets the support plane lock status
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
lockPlaneStatuslock plane status
void NXOpen::GeometricUtilities::SupportPlaneData::SetWorkView ( NXOpen::View workView)

Sets the work view required when lock plane status is NXOpen::GeometricUtilities::SupportPlaneData::LockPlaneStatusAfterFirstConstraint
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
workViewwork view
NXOpen::Plane* NXOpen::GeometricUtilities::SupportPlaneData::SupportPlane ( )

Returns the support plane
Created in NX5.0.0.



License requirements : None

NXOpen::GeometricUtilities::SupportPlaneData::LockPlaneStatus NXOpen::GeometricUtilities::SupportPlaneData::SupportPlaneLockStatus ( )

Returns the support plane lock status
Created in NX5.0.0.



License requirements : None

virtual bool NXOpen::GeometricUtilities::SupportPlaneData::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.

NXOpen::View* NXOpen::GeometricUtilities::SupportPlaneData::WorkView ( )

Returns the work view required when lock plane status is NXOpen::GeometricUtilities::SupportPlaneData::LockPlaneStatusAfterFirstConstraint
Created in NX5.0.0.



License requirements : None


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