NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Face Class Reference

Represents a face More...

Inheritance diagram for NXOpen.Face:
NXOpen.DisplayableObject NXOpen.ISurface NXOpen.IReferenceAxis NXOpen.IProfile NXOpen.IOrientation NXOpen.IParameterizedSurface NXOpen.NXObject NXOpen.IFitTo NXOpen.INXObject NXOpen.INXObject NXOpen.INXObject NXOpen.INXObject NXOpen.INXObject NXOpen.TaggedObject NXOpen.INXObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  ChamferType { OffsetOffset, OffsetAngle, Vertex }
 Chamfer type for Skylight More...
 
enum  FaceType {
  Rubber, Planar, Cylindrical, Conical,
  Spherical, SurfaceOfRevolution, Parametric, Blending,
  Offset, Swept, Convergent, Undefined
}
 Solid face type. More...
 
- Public Types inherited from NXOpen.DisplayableObject
enum  ObjectFont {
  Solid = 1, Dashed, Phantom, Centerline,
  Dotted, LongDashed, DottedDashed, Eight = 11,
  Nine, Ten, Eleven
}
 specifies the object font for objects such as lines More...
 
enum  ObjectWidth {
  Normal, Thick, Thin, One = 5,
  Two, Three, Four, Five,
  Six, Seven, Eight, Nine
}
 specifies object width for objects such as lines and text More...
 
- Public Types inherited from NXOpen.NXObject
enum  AttributeType {
  Invalid, Null, Boolean, Integer,
  Real, String, Time, Reference,
  Any = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { Numeric, Textual }
 Specifies the format of the date and time attribute. More...
 

Public Member Functions

unsafe void DestroyOwnedFacets ()
 Destroys all IFacet objects owned by this face. More...
 
unsafe void GetBlendData (out double radius, out bool isBlendFace)
 Identify blend face and get it's radius More...
 
unsafe NXOpen.Body GetBody ()
 Returns the body containing this face More...
 
unsafe bool GetChamferData (out NXOpen.Face.ChamferType chamferType, out double[] offsets)
 Check whether a face is chamfer and return the chamfer data for chamfer face More...
 
unsafe NXOpen.Edge[] GetEdges ()
 Returns the edges in the face More...
 
unsafe NXOpen.ConvergentFacet GetFirstFacetOnFace ()
 Returns first facet on convergent face. More...
 
unsafe NXOpen.ConvergentFacet GetNextFacet (NXOpen.ConvergentFacet inputFacet)
 Returns a facet next to the input facet on a convergent face. More...
 
unsafe int GetNumberOfFacets ()
 Returns the number of facets on a convergent face. More...
 
unsafe int GetNumberOfVertices ()
 Returns the number of vertices on this convergent face. More...
 
unsafe NXOpen.Edge[] GetUnsortedEdges ()
 Returns the edges in the face More...
 
- Public Member Functions inherited from NXOpen.DisplayableObject
unsafe void Blank ()
 Blanks the object. More...
 
unsafe void Highlight ()
 Highlights the object. More...
 
unsafe void RedisplayObject ()
 Redisplays the object in all views. More...
 
unsafe void RemoveViewDependency ()
 Remove dependency on all views from an object. More...
 
unsafe void SetNameLocation (NXOpen.Point3d location)
 Sets the location of the object's name. More...
 
unsafe void Unblank ()
 Unblanks the object. More...
 
unsafe void Unhighlight ()
 Unhighlights the object. More...
 
- Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
 Deletes all attributes of a specific type. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
 Deletes an attribute by type and title. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
unsafe void DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
unsafe void DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator More...
 
unsafe void DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.ComputationalTime 
GetComputationalTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe bool GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetReferenceAttribute (string title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation 
GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
unsafe string GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (NXOpen.AttributeIterator iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe int GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe bool HasUserAttribute (NXOpen.AttributeIterator iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator More...
 
unsafe bool HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetAttribute (string title, int value)
 Creates or modifies an integer attribute. More...
 
unsafe void SetAttribute (string title, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, double value)
 Creates or modifies a real attribute. More...
 
unsafe void SetAttribute (string title, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, string value)
 Creates or modifies a string attribute. More...
 
unsafe void SetAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
unsafe void SetAttribute (string title, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe void SetReferenceAttribute (string title, string value)
 Creates or modifies a string attribute which uses a reference string. More...
 
unsafe void SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
unsafe void SetTimeAttribute (string title, string value)
 Creates or modifies a time attribute. More...
 
unsafe void SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe NXOpen.Face.FaceType SolidFaceType [get]
 Returns the Parasolid type of the face More...
 
- Properties inherited from NXOpen.DisplayableObject
unsafe int Color [get, set]
 Returns or sets the color of the object. More...
 
unsafe bool IsBlanked [get]
 Returns the blank status of this object. More...
 
unsafe int Layer [get, set]
 Returns or sets the layer that the object is in. More...
 
unsafe
NXOpen.DisplayableObject.ObjectFont 
LineFont [get, set]
 Returns or sets the line font of the object. More...
 
unsafe
NXOpen.DisplayableObject.ObjectWidth 
LineWidth [get, set]
 Returns or sets the line width of the object. More...
 
unsafe NXOpen.Point3d NameLocation [get]
 Returns the location of the object's name. More...
 
- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 
- Properties inherited from NXOpen.INXObject
bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
string Name [get]
 Returns the custom name of the object. More...
 
NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a face

Created in NX3.0.0

Member Enumeration Documentation

Chamfer type for Skylight

Enumerator
OffsetOffset 

1.

The chamfer is defined by two offsets from the boundaries of the chamfer to the intersection of the face normals; 2. The chamfer is defined by two offsets from the edge to the boundaries of the chamfer

OffsetAngle 

The chamfer is defined by an edge offset and an angle

Vertex 

The chamfer whose unders are all chamfers

Solid face type.

Enumerator
Rubber 

Rubber face, no surface attached

Planar 

Planar face

Cylindrical 

Cylindrical face

Conical 

Conical face

Spherical 

Spherical face

SurfaceOfRevolution 

Face from surface of revolution

Parametric 

Parametric face

Blending 

Blending face

Offset 

Offset face

Swept 

Swept face

Convergent 

Convergent face

Undefined 

Undefined face type

Member Function Documentation

unsafe void NXOpen.Face.DestroyOwnedFacets ( )
inline

Destroys all IFacet objects owned by this face.

Please note that this method does not geometrically delete a facet from its surface mesh leaving a hole. It only deletes the tagged object created to represent the individual facet.

Created in NX12.0.0

License requirements: None.

unsafe void NXOpen.Face.GetBlendData ( out double  radius,
out bool  isBlendFace 
)
inline

Identify blend face and get it's radius

Created in NX1872.0.0

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
radius
isBlendFace
unsafe NXOpen.Body NXOpen.Face.GetBody ( )
inline

Returns the body containing this face

Created in NX3.0.0

License requirements: solid_modeling ("SOLIDS MODELING")

Returns
unsafe bool NXOpen.Face.GetChamferData ( out NXOpen.Face.ChamferType  chamferType,
out double[]  offsets 
)
inline

Check whether a face is chamfer and return the chamfer data for chamfer face

Created in NX1872.0.0

License requirements: None.

Returns
is chamfer or not
Parameters
chamferType
offsetsOffsetOffset type: offsets[0] and offsets[1] are the two offset distances; OffsetAngle: offsets[0] is the offset distance, offsets[1] is the angle; Vertex, there is no offsets values
unsafe NXOpen.Edge [] NXOpen.Face.GetEdges ( )
inline

Returns the edges in the face

The edges are sorted according to the journal identifier of the edge.

Created in NX3.0.0

License requirements: solid_modeling ("SOLIDS MODELING")

Returns
unsafe NXOpen.ConvergentFacet NXOpen.Face.GetFirstFacetOnFace ( )
inline

Returns first facet on convergent face.

This method is valid only for convergent faces. If this face is not a convergent face, then an error is returned.

Created in NX11.0.2

License requirements: solid_modeling ("SOLIDS MODELING")

Returns
the first facet on a face.
unsafe NXOpen.ConvergentFacet NXOpen.Face.GetNextFacet ( NXOpen.ConvergentFacet  inputFacet)
inline

Returns a facet next to the input facet on a convergent face.

Note that, the next facet is the facet immediately next to the given facet in an internal ordered sequence of facets. It is not necessarily adjacent to the given facet. If the input facet is the last facet on the face, then a null reference (Nothing in Visual Basic) is returned. This method is valid only for convergent faces. If this face is not a convergent face, then an error is returned.

Created in NX11.0.2

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
inputFacetthe input facet, next to which facet is to find.
Returns
the next facet.
unsafe int NXOpen.Face.GetNumberOfFacets ( )
inline

Returns the number of facets on a convergent face.

This method is valid only for convergent faces. If this face is not a convergent face, then an error is returned

Created in NX11.0.2

License requirements: solid_modeling ("SOLIDS MODELING")

Returns
the number of facets on a face
unsafe int NXOpen.Face.GetNumberOfVertices ( )
inline

Returns the number of vertices on this convergent face.

This method is valid only for convergent faces. If this face is not a convergent face, then an error is returned.

Created in NX11.0.2

License requirements: solid_modeling ("SOLIDS MODELING")

Returns
the number of vertices on a face
unsafe NXOpen.Edge [] NXOpen.Face.GetUnsortedEdges ( )
inline

Returns the edges in the face

The edges returned from this method are in no guaranteed order. This method will be faster than NXOpen.Face.GetEdges .

Created in NX12.0.0

License requirements: solid_modeling ("SOLIDS MODELING")

Returns

Property Documentation

unsafe NXOpen.Face.FaceType NXOpen.Face.SolidFaceType
get

Returns the Parasolid type of the face

Created in NX3.0.0

License requirements: solid_modeling ("SOLIDS MODELING")


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