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

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

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

List of all members.

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.
void SetExistingPlane (NXOpen::DisplayableObject *existingPlane)
 Sets the existing face or plane
Created in NX5.0.0.
void SetSupportPlane (NXOpen::Plane *supportPlane)
 Sets the support plane
Created in NX5.0.0.
void SetSupportPlaneLockStatus (NXOpen::GeometricUtilities::SupportPlaneData::LockPlaneStatus lockPlaneStatus)
 Sets the support plane lock status
Created in NX5.0.0.
void SetWorkView (NXOpen::View *workView)
 Sets the work view required when lock plane status is GeometricUtilities::SupportPlaneData::LockPlaneStatusAfterFirstConstraint
Created in NX5.0.0.
NXOpen::PlaneSupportPlane ()
 Returns the support plane
Created in NX5.0.0.
NXOpen::GeometricUtilities::SupportPlaneData::LockPlaneStatus SupportPlaneLockStatus ()
 Returns the support plane lock status
Created in NX5.0.0.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.
NXOpen::ViewWorkView ()
 Returns the work view required when lock plane status is GeometricUtilities::SupportPlaneData::LockPlaneStatusAfterFirstConstraint
Created in NX5.0.0.

Detailed Description

Represents a 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

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



License requirements : None

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



License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters:
existingPlaneexistingplane

Sets the support plane
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters:
supportPlanesupportplane

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



License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters:
lockPlaneStatuslock plane status

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



License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters:
workViewwork view

Returns the support plane
Created in NX5.0.0.



License requirements : None

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



License requirements : None

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.

Returns the work view required when lock plane status is GeometricUtilities::SupportPlaneData::LockPlaneStatusAfterFirstConstraint
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.