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

Represents a NXOpen::MeasureDistanceBuilder
To create a new instance of this class, use NXOpen::MeasureManager::CreateMeasureDistanceBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::MeasureDistanceBuilder:
NXOpen::MeasureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Routing::RoutingMeasureDistanceBuilder

Public Types

enum  DistanceType {
  DistanceTypeDistance, DistanceTypeSmartDistance, DistanceTypeProjectedDistance, DistanceTypeSmartProjectedDistance,
  DistanceTypeScreenDistance, DistanceTypeLength, DistanceTypeRadius, DistanceTypeDiameter,
  DistanceTypePointsOnCurves, DistanceTypeRoutingPathLength, DistanceTypeBetweenSets
}
 the type of distance measurement More...
 
enum  MeasureType {
  MeasureTypeToAPoint, MeasureTypeMinimum, MeasureTypeLocalMinimum, MeasureTypeMaximum,
  MeasureTypeMinClearance, MeasureTypeMaxClearance
}
 the subtype of distance measurement More...
 
- Public Types inherited from NXOpen::MeasureBuilder
enum  AnnotationType { AnnotationTypeNone, AnnotationTypeShowDimension, AnnotationTypeCreateLine, AnnotationTypeCreateCsys }
 Represents the annotation type. More...
 
enum  RequirementType { RequirementTypeNone, RequirementTypeNew, RequirementTypeExisting }
 Represents the requirement type. More...
 

Public Member Functions

NXOpen::SelectDisplayableObjectDiameterObjects ()
 Returns the diameter objects
Created in NX8.5.0. More...
 
NXOpen::ScCollectorDistanceCollector1 ()
 Returns the first collector of objects for distance between two collectors
Created in NX8.5.0. More...
 
NXOpen::ScCollectorDistanceCollector2 ()
 Returns the second collector of objects for distance between two collectors
Created in NX8.5.0. More...
 
bool IsExact ()
 Returns the exact flag
Created in NX7.5.0. More...
 
NXOpen::ScCollectorLengthCollector ()
 Returns the length collector of objects
Created in NX8.5.0. More...
 
NXOpen::SelectDisplayableObjectListLengthObjects ()
 Returns the length objects
Created in NX5.0.0. More...
 
NXOpen::MeasureDistanceBuilder::MeasureType Mtype ()
 Returns the mtype
Created in NX5.0.0. More...
 
NXOpen::SelectDisplayableObjectObject1 ()
 Returns the object1
Created in NX5.0.0. More...
 
NXOpen::SelectDisplayableObjectObject2 ()
 Returns the object2
Created in NX5.0.0. More...
 
NXOpen::DirectionProjectionVector ()
 Returns the projection vector
Created in NX5.0.0. More...
 
NXOpen::SelectDisplayableObjectRadiusObjects ()
 Returns the radius objects
Created in NX5.0.0. More...
 
NXOpen::SelectDisplayableObjectListSet1 ()
 Returns the set1
Created in NX5.0.0. More...
 
NXOpen::SelectDisplayableObjectListSet2 ()
 Returns the set2
Created in NX5.0.0. More...
 
void SetExact (bool isExact)
 Sets the exact flag
Created in NX7.5.0. More...
 
void SetMtype (NXOpen::MeasureDistanceBuilder::MeasureType mtype)
 Sets the mtype
Created in NX5.0.0. More...
 
void SetProjectionVector (NXOpen::Direction *projectionVector)
 Sets the projection vector
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::MeasureBuilder
NXOpen::MeasureBuilder::AnnotationType AnnotationMode ()
 Returns the annotation mode
Created in NX5.0.0. More...
 
bool InfoWindow ()
 Returns the info window
Created in NX5.0.0. More...
 
NXOpen::MeasureBuilder::RequirementType RequirementMode ()
 Returns the requirement mode
Created in NX5.0.0. More...
 
void SetAnnotationMode (NXOpen::MeasureBuilder::AnnotationType atype)
 Sets the annotation mode
Created in NX5.0.0. More...
 
void SetInfoWindow (bool infoWindow)
 Sets the info window
Created in NX5.0.0. More...
 
void SetRequirementMode (NXOpen::MeasureBuilder::RequirementType rtype)
 Sets the requirement mode
Created in NX5.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::MeasureDistanceBuilder
To create a new instance of this class, use NXOpen::MeasureManager::CreateMeasureDistanceBuilder

Created in NX5.0.0.


Member Enumeration Documentation

the type of distance measurement

Enumerator
DistanceTypeDistance 

distance

DistanceTypeSmartDistance 

smart distance

DistanceTypeProjectedDistance 

projected distance

DistanceTypeSmartProjectedDistance 

smart projected distance

DistanceTypeScreenDistance 

screen distance

DistanceTypeLength 

length

DistanceTypeRadius 

radius

DistanceTypeDiameter 

diameter

DistanceTypePointsOnCurves 

points on curves

DistanceTypeRoutingPathLength 

routing path length

DistanceTypeBetweenSets 

between sets

the subtype of distance measurement

Enumerator
MeasureTypeToAPoint 

to apoint

MeasureTypeMinimum 

minimum

MeasureTypeLocalMinimum 

local minimum

MeasureTypeMaximum 

maximum

MeasureTypeMinClearance 

min clearance

MeasureTypeMaxClearance 

max clearance

Member Function Documentation

NXOpen::SelectDisplayableObject* NXOpen::MeasureDistanceBuilder::DiameterObjects ( )

Returns the diameter objects
Created in NX8.5.0.



License requirements : None

NXOpen::ScCollector* NXOpen::MeasureDistanceBuilder::DistanceCollector1 ( )

Returns the first collector of objects for distance between two collectors
Created in NX8.5.0.



License requirements : None

NXOpen::ScCollector* NXOpen::MeasureDistanceBuilder::DistanceCollector2 ( )

Returns the second collector of objects for distance between two collectors
Created in NX8.5.0.



License requirements : None

bool NXOpen::MeasureDistanceBuilder::IsExact ( )

Returns the exact flag
Created in NX7.5.0.



License requirements : None

NXOpen::ScCollector* NXOpen::MeasureDistanceBuilder::LengthCollector ( )

Returns the length collector of objects
Created in NX8.5.0.



License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::MeasureDistanceBuilder::LengthObjects ( )

Returns the length objects
Created in NX5.0.0.



License requirements : None

NXOpen::MeasureDistanceBuilder::MeasureType NXOpen::MeasureDistanceBuilder::Mtype ( )

Returns the mtype
Created in NX5.0.0.



License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::MeasureDistanceBuilder::Object1 ( )

Returns the object1
Created in NX5.0.0.



License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::MeasureDistanceBuilder::Object2 ( )

Returns the object2
Created in NX5.0.0.



License requirements : None

NXOpen::Direction* NXOpen::MeasureDistanceBuilder::ProjectionVector ( )

Returns the projection vector
Created in NX5.0.0.



License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::MeasureDistanceBuilder::RadiusObjects ( )

Returns the radius objects
Created in NX5.0.0.



License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::MeasureDistanceBuilder::Set1 ( )

Returns the set1
Created in NX5.0.0.



License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::MeasureDistanceBuilder::Set2 ( )

Returns the set2
Created in NX5.0.0.



License requirements : None

void NXOpen::MeasureDistanceBuilder::SetExact ( bool  isExact)

Sets the exact flag
Created in NX7.5.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
isExactisexact
void NXOpen::MeasureDistanceBuilder::SetMtype ( NXOpen::MeasureDistanceBuilder::MeasureType  mtype)

Sets the mtype
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
mtypemtype
void NXOpen::MeasureDistanceBuilder::SetProjectionVector ( NXOpen::Direction projectionVector)

Sets the projection vector
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
projectionVectorprojectionvector

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