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

Represents a NXOpen::Annotations::OrdinateDimension builder
This is an abstract class and cannot be instantiated. More...

Inheritance diagram for NXOpen::Annotations::BaseOrdinateDimensionBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Annotations::OrdinateDimensionBuilder NXOpen::Annotations::PmiOrdinateDimensionBuilder

Public Types

enum  Types { TypesSingleDimension, TypesMultipleDimension }
 the type of dimension being created More...
 

Public Member Functions

NXOpen::Annotations::OrdinateMarginActiveHorizontalMargin ()
 Returns the active horizontal margin(defined or inferred) where horizontal dimension will be automatically placed. More...
 
NXOpen::Annotations::OrdinateMarginActiveVerticalMargin ()
 Returns the active vertical margin(defined or inferred) where horizontal dimension will be automatically placed. More...
 
bool AllowDuplicates ()
 Returns the allow duplicates
Created in NX9.0.0. More...
 
NXOpen::Annotations::AppendedTextBuilderAppendedText ()
 Returns the appended text
Created in NX9.0.0. More...
 
NXOpen::SelectDisplayableObjectListAutoAssociativities ()
 Returns the auto ordinate associativities
Created in NX9.0.0. More...
 
NXOpen::Annotations::OrdinateBaselineBuilderBaseline ()
 Returns the baseline
Created in NX9.0.0. More...
 
NXOpen::Point3d HorizontalInferredMarginLocation ()
 Returns the horizontal inferred margin location
Created in NX9.0.0. More...
 
NXOpen::SelectDisplayableObjectInherit ()
 Returns the inherit
Created in NX9.0.0. More...
 
NXOpen::SelectDisplayableObjectOrdinateOrigin ()
 Returns the ordinate origin
Created in NX9.0.0. More...
 
NXOpen::Annotations::OriginBuilderOrigin ()
 Returns the origin
Created in NX9.0.0. More...
 
bool RespositionExisting ()
 Returns the resposition existing
Created in NX9.0.0. More...
 
NXOpen::SelectDisplayableObjectSecondAssociativities ()
 Returns the second associativities
Created in NX9.0.0. More...
 
void SetActiveHorizontalMargin (NXOpen::Annotations::OrdinateMargin *margin)
 Sets the active horizontal margin(defined or inferred) where horizontal dimension will be automatically placed. More...
 
void SetActiveVerticalMargin (NXOpen::Annotations::OrdinateMargin *margin)
 Sets the active vertical margin(defined or inferred) where horizontal dimension will be automatically placed. More...
 
void SetAllowDuplicates (bool allowDuplicates)
 Sets the allow duplicates
Created in NX9.0.0. More...
 
void SetHorizontalInferredMarginLocation (const NXOpen::Point3d &location)
 Sets the horizontal inferred margin location
Created in NX9.0.0. More...
 
void SetRespositionExisting (bool respositionExisting)
 Sets the resposition existing
Created in NX9.0.0. More...
 
void SetType (NXOpen::Annotations::BaseOrdinateDimensionBuilder::Types type)
 Sets the type
Created in NX9.0.0. More...
 
void SetVerticalInferredMarginLocation (const NXOpen::Point3d &location)
 Sets the vertical inferred margin location
Created in NX9.0.0. More...
 
NXOpen::Annotations::StyleBuilderStyle ()
 Returns the style
Created in NX9.0.0. More...
 
NXOpen::Annotations::BaseOrdinateDimensionBuilder::Types Type ()
 Returns the type
Created in NX9.0.0. More...
 
NXOpen::Point3d VerticalInferredMarginLocation ()
 Returns the vertical inferred margin location
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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 a NXOpen::Annotations::OrdinateDimension builder
This is an abstract class and cannot be instantiated.



Created in NX9.0.0.

Member Enumeration Documentation

the type of dimension being created

Enumerator
TypesSingleDimension 

singular dimension

TypesMultipleDimension 

group or set of dimensions

Member Function Documentation

NXOpen::Annotations::OrdinateMargin* NXOpen::Annotations::BaseOrdinateDimensionBuilder::ActiveHorizontalMargin ( )

Returns the active horizontal margin(defined or inferred) where horizontal dimension will be automatically placed.

A margin can be created using NXOpen::Annotations::OrdinateMarginCollection . If NULL, must set a HorizontalInferredMarginLocation which will be used to place dimension
Created in NX9.0.0.

License requirements : None

NXOpen::Annotations::OrdinateMargin* NXOpen::Annotations::BaseOrdinateDimensionBuilder::ActiveVerticalMargin ( )

Returns the active vertical margin(defined or inferred) where horizontal dimension will be automatically placed.

A margin can be created using NXOpen::Annotations::OrdinateMarginCollection . If NULL, must set a VerticalInferredMarginLocation which will be used to place dimension
Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::BaseOrdinateDimensionBuilder::AllowDuplicates ( )

Returns the allow duplicates
Created in NX9.0.0.



License requirements : None

NXOpen::Annotations::AppendedTextBuilder* NXOpen::Annotations::BaseOrdinateDimensionBuilder::AppendedText ( )

Returns the appended text
Created in NX9.0.0.



License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Annotations::BaseOrdinateDimensionBuilder::AutoAssociativities ( )

Returns the auto ordinate associativities
Created in NX9.0.0.



License requirements : None

NXOpen::Annotations::OrdinateBaselineBuilder* NXOpen::Annotations::BaseOrdinateDimensionBuilder::Baseline ( )

Returns the baseline
Created in NX9.0.0.



License requirements : None

NXOpen::Point3d NXOpen::Annotations::BaseOrdinateDimensionBuilder::HorizontalInferredMarginLocation ( )

Returns the horizontal inferred margin location
Created in NX9.0.0.



License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Annotations::BaseOrdinateDimensionBuilder::Inherit ( )

Returns the inherit
Created in NX9.0.0.



License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Annotations::BaseOrdinateDimensionBuilder::OrdinateOrigin ( )

Returns the ordinate origin
Created in NX9.0.0.



License requirements : None

NXOpen::Annotations::OriginBuilder* NXOpen::Annotations::BaseOrdinateDimensionBuilder::Origin ( )

Returns the origin
Created in NX9.0.0.



License requirements : None

bool NXOpen::Annotations::BaseOrdinateDimensionBuilder::RespositionExisting ( )

Returns the resposition existing
Created in NX9.0.0.



License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Annotations::BaseOrdinateDimensionBuilder::SecondAssociativities ( )

Returns the second associativities
Created in NX9.0.0.



License requirements : None

void NXOpen::Annotations::BaseOrdinateDimensionBuilder::SetActiveHorizontalMargin ( NXOpen::Annotations::OrdinateMargin margin)

Sets the active horizontal margin(defined or inferred) where horizontal dimension will be automatically placed.

A margin can be created using NXOpen::Annotations::OrdinateMarginCollection . If NULL, must set a HorizontalInferredMarginLocation which will be used to place dimension
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters
marginmargin
void NXOpen::Annotations::BaseOrdinateDimensionBuilder::SetActiveVerticalMargin ( NXOpen::Annotations::OrdinateMargin margin)

Sets the active vertical margin(defined or inferred) where horizontal dimension will be automatically placed.

A margin can be created using NXOpen::Annotations::OrdinateMarginCollection . If NULL, must set a VerticalInferredMarginLocation which will be used to place dimension
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters
marginmargin
void NXOpen::Annotations::BaseOrdinateDimensionBuilder::SetAllowDuplicates ( bool  allowDuplicates)

Sets the allow duplicates
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
allowDuplicatesallowduplicates
void NXOpen::Annotations::BaseOrdinateDimensionBuilder::SetHorizontalInferredMarginLocation ( const NXOpen::Point3d location)

Sets the horizontal inferred margin location
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
locationlocation
void NXOpen::Annotations::BaseOrdinateDimensionBuilder::SetRespositionExisting ( bool  respositionExisting)

Sets the resposition existing
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
respositionExistingrespositionexisting
void NXOpen::Annotations::BaseOrdinateDimensionBuilder::SetType ( NXOpen::Annotations::BaseOrdinateDimensionBuilder::Types  type)

Sets the type
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
typetype
void NXOpen::Annotations::BaseOrdinateDimensionBuilder::SetVerticalInferredMarginLocation ( const NXOpen::Point3d location)

Sets the vertical inferred margin location
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
locationlocation
NXOpen::Annotations::StyleBuilder* NXOpen::Annotations::BaseOrdinateDimensionBuilder::Style ( )

Returns the style
Created in NX9.0.0.



License requirements : None

NXOpen::Annotations::BaseOrdinateDimensionBuilder::Types NXOpen::Annotations::BaseOrdinateDimensionBuilder::Type ( )

Returns the type
Created in NX9.0.0.



License requirements : None

NXOpen::Point3d NXOpen::Annotations::BaseOrdinateDimensionBuilder::VerticalInferredMarginLocation ( )

Returns the vertical inferred margin location
Created in NX9.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.