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

Represents a Drawings::SectionLineBuilder . More...

Inheritance diagram for NXOpen::Drawings::SectionLineBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Types {
  TypesSimpleOrStepped, TypesHalf, TypesRevolved, TypesPointToPoint,
  TypesPointAndAngle, TypesPictorial, TypesHalfPictorial, TypesOriented
}
 Section Line type. More...
 

Public Member Functions

NXOpen::DirectionArrowDirection ()
 Returns the arrow direction.
 
NXOpen::DirectionCutDirection ()
 Returns the cut direction.
 
NXOpen::Drawings::HalfSectionLineBuilderHalf ()
 Returns the half section line data.
 
NXOpen::Drawings::HalfSectionLineBuilderHalfPictorial ()
 Returns the half pictorial section line data.
 
NXOpen::DirectionHingeDirection ()
 Returns the hinge direction.
 
NXOpen::Drawings::OrientedSectionLineBuilderOriented ()
 Returns the simple 3D section line data.
 
NXOpen::Drawings::ParentViewBuilderParentView ()
 Returns the parent view.
 
NXOpen::Drawings::SteppedSectionLineBuilderPictorial ()
 Returns the pictorial section line data.
 
NXOpen::Drawings::PointAndAngleSectionLineBuilderPointAndAngle ()
 Returns the point and angle section line data.
 
NXOpen::Drawings::PointToPointSectionLineBuilderPointToPoint ()
 Returns the point to point section line data.
 
NXOpen::Drawings::RevolvedSectionLineBuilderRevolved ()
 Returns the revolved section line data.
 
void SetArrowDirection (NXOpen::Direction *arrowDirection)
 Sets the arrow direction.
 
void SetCutDirection (NXOpen::Direction *cutDirection)
 Sets the cut direction.
 
void SetHingeDirection (NXOpen::Direction *hingeDirection)
 Sets the hinge direction.
 
void SetType (NXOpen::Drawings::SectionLineBuilder::Types type)
 Sets the section line type
Created in NX6.0.0.
 
NXOpen::Drawings::SteppedSectionLineBuilderSimpleOrStepped ()
 Returns the simple or stepped section line data.
 
NXOpen::Drawings::SectionLineStyleBuilderStyle ()
 Returns the style.
 
NXOpen::Drawings::SectionLineBuilder::Types Type ()
 Returns the section line type
Created in NX6.0.0.
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder.
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder.
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit.
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder.
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results.
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t GetTag () const
 
<b>Deprecated</b>:<br>

   Use Tag instead.

 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Represents a Drawings::SectionLineBuilder .

   This class is used to create or edit a
   @link Drawings::SectionLine Drawings::SectionLine@endlink .  <br> To create a new instance of this class, use @link Drawings::SectionLineCollection::CreateSectionLineBuilder  Drawings::SectionLineCollection::CreateSectionLineBuilder @endlink  <br> 


Created in NX6.0.0.

Member Enumeration Documentation

Section Line type.

Enumerator:
TypesSimpleOrStepped 

Creates or edits a Drawings::SteppedSectionLine.

TypesHalf 

Creates or edits a Drawings::HalfSectionLine.

TypesRevolved 

Creates or edits a Drawings::RevolvedSectionLine.

TypesPointToPoint 

Creates or edits a Drawings::PointToPointSectionLine.

TypesPointAndAngle 

Creates or edits a Drawings::PointAndAngleSectionLine.

TypesPictorial 

Creates or edits a Drawings::PictorialSectionLine.

TypesHalfPictorial 

Creates or edits a Drawings::HalfPictorialSectionLine.

TypesOriented 

Creates or edits a Drawings::OrientedSectionLine.

Member Function Documentation

NXOpen::Direction* NXOpen::Drawings::SectionLineBuilder::ArrowDirection ( )

Returns the arrow direction.

The arrow direction defines the direction of the section line arrows and must be perpendicular to the cut direction.

The arrow direction is only used for Drawings::SectionLineBuilder::TypesPictorial , Drawings::SectionLineBuilder::TypesHalfPictorial and Drawings::SectionLineBuilder::TypesOriented section lines
Created in NX6.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Drawings::SectionLineBuilder::CutDirection ( )

Returns the cut direction.

The cut direction is a vector that specifies the direction of the cutting plane. A vector arrow displays showing the direction of the vector.

The cut direction is only used for Drawings::SectionLineBuilder::TypesPictorial , Drawings::SectionLineBuilder::TypesHalfPictorial and Drawings::SectionLineBuilder::TypesOriented section lines
Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::HalfSectionLineBuilder* NXOpen::Drawings::SectionLineBuilder::Half ( )

Returns the half section line data.

       Use the half section line data when the type is set to
       @link Drawings::SectionLineBuilder::TypesHalf Drawings::SectionLineBuilder::TypesHalf@endlink  


Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::HalfSectionLineBuilder* NXOpen::Drawings::SectionLineBuilder::HalfPictorial ( )

Returns the half pictorial section line data.

       Use the half pictorial section line data when the type is set to
       @link Drawings::SectionLineBuilder::TypesHalfPictorial Drawings::SectionLineBuilder::TypesHalfPictorial@endlink  


Created in NX6.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Drawings::SectionLineBuilder::HingeDirection ( )

Returns the hinge direction.

       The hinge direction is only used for 
       @link Drawings::SectionLineBuilder::TypesSimpleOrStepped Drawings::SectionLineBuilder::TypesSimpleOrStepped@endlink  ,
       @link Drawings::SectionLineBuilder::TypesHalf Drawings::SectionLineBuilder::TypesHalf@endlink  ,
       @link Drawings::SectionLineBuilder::TypesRevolved Drawings::SectionLineBuilder::TypesRevolved@endlink  ,
       @link Drawings::SectionLineBuilder::TypesPointToPoint Drawings::SectionLineBuilder::TypesPointToPoint@endlink  , and
       @link Drawings::SectionLineBuilder::TypesPointAndAngle Drawings::SectionLineBuilder::TypesPointAndAngle@endlink  section lines 


Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::OrientedSectionLineBuilder* NXOpen::Drawings::SectionLineBuilder::Oriented ( )

Returns the simple 3D section line data.

       Use the simple 3D section line data when the type is set to
       @link Drawings::SectionLineBuilder::TypesOriented Drawings::SectionLineBuilder::TypesOriented@endlink  


Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::ParentViewBuilder* NXOpen::Drawings::SectionLineBuilder::ParentView ( )

Returns the parent view.

The view that the section line will cut.
Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::SteppedSectionLineBuilder* NXOpen::Drawings::SectionLineBuilder::Pictorial ( )

Returns the pictorial section line data.

       Use the pictorial section line data when the type is set to
       @link Drawings::SectionLineBuilder::TypesPictorial Drawings::SectionLineBuilder::TypesPictorial@endlink  


Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::PointAndAngleSectionLineBuilder* NXOpen::Drawings::SectionLineBuilder::PointAndAngle ( )

Returns the point and angle section line data.

       Use the point and angle section line data when the type is set to
       @link Drawings::SectionLineBuilder::TypesPointAndAngle Drawings::SectionLineBuilder::TypesPointAndAngle@endlink  


Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::PointToPointSectionLineBuilder* NXOpen::Drawings::SectionLineBuilder::PointToPoint ( )

Returns the point to point section line data.

       Use the point to point section line data when the type is set to
       @link Drawings::SectionLineBuilder::TypesPointToPoint Drawings::SectionLineBuilder::TypesPointToPoint@endlink  


Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::RevolvedSectionLineBuilder* NXOpen::Drawings::SectionLineBuilder::Revolved ( )

Returns the revolved section line data.

       Use the revolved section line data when the type is set to
       @link Drawings::SectionLineBuilder::TypesRevolved Drawings::SectionLineBuilder::TypesRevolved@endlink  


Created in NX6.0.0.

License requirements : None

void NXOpen::Drawings::SectionLineBuilder::SetArrowDirection ( NXOpen::Direction arrowDirection)

Sets the arrow direction.

The arrow direction defines the direction of the section line arrows and must be perpendicular to the cut direction.

The arrow direction is only used for Drawings::SectionLineBuilder::TypesPictorial , Drawings::SectionLineBuilder::TypesHalfPictorial and Drawings::SectionLineBuilder::TypesOriented section lines
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
arrowDirectionarrowdirection
void NXOpen::Drawings::SectionLineBuilder::SetCutDirection ( NXOpen::Direction cutDirection)

Sets the cut direction.

The cut direction is a vector that specifies the direction of the cutting plane. A vector arrow displays showing the direction of the vector.

The cut direction is only used for Drawings::SectionLineBuilder::TypesPictorial , Drawings::SectionLineBuilder::TypesHalfPictorial and Drawings::SectionLineBuilder::TypesOriented section lines
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
cutDirectioncutdirection
void NXOpen::Drawings::SectionLineBuilder::SetHingeDirection ( NXOpen::Direction hingeDirection)

Sets the hinge direction.

       The hinge direction is only used for 
       @link Drawings::SectionLineBuilder::TypesSimpleOrStepped Drawings::SectionLineBuilder::TypesSimpleOrStepped@endlink  ,
       @link Drawings::SectionLineBuilder::TypesHalf Drawings::SectionLineBuilder::TypesHalf@endlink  ,
       @link Drawings::SectionLineBuilder::TypesRevolved Drawings::SectionLineBuilder::TypesRevolved@endlink  ,
       @link Drawings::SectionLineBuilder::TypesPointToPoint Drawings::SectionLineBuilder::TypesPointToPoint@endlink  , and
       @link Drawings::SectionLineBuilder::TypesPointAndAngle Drawings::SectionLineBuilder::TypesPointAndAngle@endlink  section lines 


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
hingeDirectionhingedirection
void NXOpen::Drawings::SectionLineBuilder::SetType ( NXOpen::Drawings::SectionLineBuilder::Types  type)

Sets the section line type
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
typetype
NXOpen::Drawings::SteppedSectionLineBuilder* NXOpen::Drawings::SectionLineBuilder::SimpleOrStepped ( )

Returns the simple or stepped section line data.

       Use the simple or stepped section line data when the type is set to
       @link Drawings::SectionLineBuilder::TypesSimpleOrStepped Drawings::SectionLineBuilder::TypesSimpleOrStepped@endlink  


Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::SectionLineStyleBuilder* NXOpen::Drawings::SectionLineBuilder::Style ( )

Returns the style.

The preferences of a section line.
Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::SectionLineBuilder::Types NXOpen::Drawings::SectionLineBuilder::Type ( )

Returns the section line type
Created in NX6.0.0.



License requirements : None


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