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

Represents the Geometric Properties class. More...

Inheritance diagram for NXOpen::GeometricAnalysis::GeometricProperties:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Classes

struct  CaeCurve
 CAE Edge/Curve Geometric Properties. More...
 
struct  CaeFace
 CAE Face Geometric Properties. More...
 
struct  Edge
 Edge/Curve Geometric Properties. More...
 
struct  Face
 Face Geometric Properties. More...
 

Public Types

enum  Entity { EntityFace, EntityEdge, EntityCaeFace, EntityCaeCurve }
 Type of input entity for geometric properties. More...
 
enum  OutputType { OutputTypeDynamic, OutputTypeStatic }
 Represents how to output geometric properties. More...
 
enum  Status { StatusSuccess, StatusInvalidInput, StatusFailed }
 Status of computing geometric properties. More...
 

Public Member Functions

NXOpen::GeometricAnalysis::GeometricProperties::Status GetCaeCurveProperties (NXOpen::NXObject *entityTag, const NXOpen::Point3d &absPoint, NXOpen::GeometricAnalysis::GeometricProperties::CaeCurve *caeCurve)
 Returns CAE curve local properties at the given point. More...
 
NXOpen::GeometricAnalysis::GeometricProperties::Status GetCaeFaceProperties (NXOpen::NXObject *entityTag, const NXOpen::Point3d &absPoint, NXOpen::GeometricAnalysis::GeometricProperties::CaeFace *caeFace)
 Returns CAE face local properties at the given point. More...
 
NXOpen::GeometricAnalysis::GeometricProperties::Status GetEdgeProperties (NXOpen::NXObject *entityTag, const NXOpen::Point3d &absPoint, NXOpen::GeometricAnalysis::GeometricProperties::Edge *edge)
 Returns edge/curve local properties at the given point. More...
 
NXOpen::GeometricAnalysis::GeometricProperties::Status GetFaceProperties (NXOpen::NXObject *entityTag, const NXOpen::Point3d &absPoint, NXOpen::GeometricAnalysis::GeometricProperties::Face *face)
 Returns face local properties at the given point. More...
 
NXOpen::GeometricAnalysis::GeometricProperties::Status ListProperties (NXOpen::NXObject *entityTag, const NXOpen::Point3d &absPoint)
 Displays the local properties of the specified object at the given point in the listing window. More...
 
NXOpen::GeometricAnalysis::GeometricProperties::Status ListProperties (const NXOpen::Point3d &absPoint)
 Displays the local properties of ObjectsForAnalysis at the given point in the listing window. More...
 
NXOpen::SelectObjectListObjectsForAnalysis ()
 Returns the Objects for analysis
Created in NX5.0.0. More...
 
NXOpen::GeometricAnalysis::GeometricProperties::OutputType OutputMethod ()
 Returns the output method
Created in NX5.0.0. More...
 
void Reset ()
 Clears all markers showing the local geometric properties in the graphics window
Created in NX5.0.0. More...
 
void SetOutputMethod (NXOpen::GeometricAnalysis::GeometricProperties::OutputType outputMethod)
 Sets the output method
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 the Geometric Properties class.

This class can be used to find local geometric properties of faces, edges, curves, CAE faces, and CAE edges/curves at a given point.
To create a new instance of this class, use NXOpen::GeometricAnalysis::AnalysisManager::CreateGeometricPropertiesObject

Created in NX5.0.0.

Member Enumeration Documentation

Type of input entity for geometric properties.

Enumerator
EntityFace 

Face.

EntityEdge 

Either a modeling edge or a curve.

EntityCaeFace 

CAE Face.

EntityCaeCurve 

CAE Curve.

Represents how to output geometric properties.

GeometricAnalysis::GeometricProperties::OutputTypeDynamic displays the properties of an entity under the cursor when NX is run interactively.

Enumerator
OutputTypeDynamic 

Properties of an entity are displayed first on the dialog itself on mouse over.

These properties are listed on in the information window upon selection of a point.

OutputTypeStatic 

Propeties of the selected entities are displayed in the information window.

Status of computing geometric properties.

Enumerator
StatusSuccess 

Success.

StatusInvalidInput 

Input specified is not valid.

StatusFailed 

Failed to find all geometric properties.

Member Function Documentation

NXOpen::GeometricAnalysis::GeometricProperties::Status NXOpen::GeometricAnalysis::GeometricProperties::GetCaeCurveProperties ( NXOpen::NXObject entityTag,
const NXOpen::Point3d absPoint,
NXOpen::GeometricAnalysis::GeometricProperties::CaeCurve caeCurve 
)

Returns CAE curve local properties at the given point.

Returns
Return status
Created in NX5.0.0.

License requirements : None
Parameters
entityTagNXObject to obtain the properties for
absPointAbsolute point co-ordinates of the reference point to compute the properties
caeCurveCAE Edge/Curve Properties
NXOpen::GeometricAnalysis::GeometricProperties::Status NXOpen::GeometricAnalysis::GeometricProperties::GetCaeFaceProperties ( NXOpen::NXObject entityTag,
const NXOpen::Point3d absPoint,
NXOpen::GeometricAnalysis::GeometricProperties::CaeFace caeFace 
)

Returns CAE face local properties at the given point.

Returns
Return status
Created in NX5.0.0.

License requirements : None
Parameters
entityTagNXObject to obtain the properties for
absPointAbsolute point co-ordinates of the reference point to compute the properties
caeFaceCAE Face Properties
NXOpen::GeometricAnalysis::GeometricProperties::Status NXOpen::GeometricAnalysis::GeometricProperties::GetEdgeProperties ( NXOpen::NXObject entityTag,
const NXOpen::Point3d absPoint,
NXOpen::GeometricAnalysis::GeometricProperties::Edge edge 
)

Returns edge/curve local properties at the given point.

Returns
Return status
Created in NX5.0.0.

License requirements : None
Parameters
entityTagNXObject to obtain the properties for
absPointAbsolute point co-ordinates of the reference point to compute the properties
edgeEdge/Curve Properties
NXOpen::GeometricAnalysis::GeometricProperties::Status NXOpen::GeometricAnalysis::GeometricProperties::GetFaceProperties ( NXOpen::NXObject entityTag,
const NXOpen::Point3d absPoint,
NXOpen::GeometricAnalysis::GeometricProperties::Face face 
)

Returns face local properties at the given point.

Returns
Return status
Created in NX5.0.0.

License requirements : None
Parameters
entityTagNXObject to obtain the properties for
absPointAbsolute point co-ordinates of the reference point to compute the properties
faceFace Properties
NXOpen::GeometricAnalysis::GeometricProperties::Status NXOpen::GeometricAnalysis::GeometricProperties::ListProperties ( NXOpen::NXObject entityTag,
const NXOpen::Point3d absPoint 
)

Displays the local properties of the specified object at the given point in the listing window.

Returns
Return status
Created in NX5.0.0.

License requirements : None
Parameters
entityTagNXObject to obtain the properties for
absPointAbsolute point co-ordinates of the reference point to compute the properties
NXOpen::GeometricAnalysis::GeometricProperties::Status NXOpen::GeometricAnalysis::GeometricProperties::ListProperties ( const NXOpen::Point3d absPoint)

Displays the local properties of ObjectsForAnalysis at the given point in the listing window.

Returns
Return status
Created in NX5.0.0.

License requirements : None
Parameters
absPointAbsolute point co-ordinates of the reference point to compute the properties
NXOpen::SelectObjectList* NXOpen::GeometricAnalysis::GeometricProperties::ObjectsForAnalysis ( )

Returns the Objects for analysis
Created in NX5.0.0.



License requirements : None

NXOpen::GeometricAnalysis::GeometricProperties::OutputType NXOpen::GeometricAnalysis::GeometricProperties::OutputMethod ( )

Returns the output method
Created in NX5.0.0.



License requirements : None

void NXOpen::GeometricAnalysis::GeometricProperties::Reset ( )

Clears all markers showing the local geometric properties in the graphics window
Created in NX5.0.0.



License requirements : None

void NXOpen::GeometricAnalysis::GeometricProperties::SetOutputMethod ( NXOpen::GeometricAnalysis::GeometricProperties::OutputType  outputMethod)

Sets the output method
Created in NX5.0.0.



License requirements : None

Parameters
outputMethodoutput method

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