FacetedEdge Class

class NXOpen.Facet.FacetedEdge

Bases: NXOpen.DisplayableObject, NXOpen.IBaseCurve

Represents a faceted edge.

Instances of this class may be generated when recording a journal, but they cannot be created directly.

New in version NX5.0.0.

Properties

Property Description
Color Returns or sets the color of the object.
EdgeType Returns the type of the facet edge
IsBlanked Returns the blank status of this object.
IsOccurrence Returns whether this object is an occurrence or not.
IsReference Returns the reference state of a curve
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Layer Returns or sets the layer that the object is in.
LineFont Returns or sets the line font of the object.
LineWidth Returns or sets the line width of the object.
Name Returns the custom name of the object.
NameLocation Returns the location of the object’s name.
OwningComponent Returns the owning component, if this object is an occurrence.
OwningPart Returns the owning part of this object
Prototype Returns the prototype of this object if it is an occurrence.
Tag Returns the Tag for this object.

Methods

Method Description
Blank Blanks the object.
CreateAttributeIterator Create an attribute iterator
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteUserAttribute Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBody Returns the body containing this edge
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetCurveData Returns the curve information for the facet edge Parameter description faceted_edge : The input edge tag for which curve information is required.
GetFaces Returns the faces connected to the edge
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetLength Returns the length of the object
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue Gets the value of PDM Reference attribute for given object.
GetRealAttribute Gets a real attribute by title.
GetRealUserAttribute Gets a real attribute by Title and array Index.
GetReferenceAttribute Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute Gets a string attribute value by title.
GetStringUserAttribute Gets a string attribute by Title and array Index.
GetTimeAttribute Gets a time attribute by title.
GetTimeUserAttribute Gets a time attribute by Title and array Index.
GetUserAttribute Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock Determine the lock of the given attribute.
GetUserAttributeSize Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects Returns an array of objects from which this object presents attributes.
GetUserAttributes Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings Gets all the attributes that have been set on the given object.
GetVertices Returns the vertices of the edge.
HasUserAttribute Determines if an attribute exists on the object, that satisfies the given iterator
Highlight Highlights the object.
Print Prints a representation of this object to the system log file.
RedisplayObject Redisplays the object in all views.
RemoveViewDependency Remove dependency on all views from an object.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetName Sets the custom name of the object.
SetNameLocation Sets the location of the object’s name.
SetPdmReferenceAttribute Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute Creates or modifies a time attribute.
SetTimeUserAttribute Creates or modifies a time attribute with the option to update or not.
SetUserAttribute Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock Lock or unlock the given attribute.
Unblank Unblanks the object.
Unhighlight Unhighlights the object.

Enumerations

FacetedEdgeFacetededgeType Enumeration Facet Edge type

Property Detail

EdgeType

FacetedEdge.EdgeType

Returns the type of the facet edge

-------------------------------------

Getter Method

Signature EdgeType

Returns:
Return type:NXOpen.Facet.FacetedEdgeFacetededgeType

New in version NX8.5.1.

License requirements: None.

IsOccurrence

FacetedEdge.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence
Return type:bool

New in version NX3.0.0.

License requirements: None.

IsReference

FacetedEdge.IsReference

Returns the reference state of a curve

-------------------------------------

Getter Method

Signature IsReference

Returns:True - Reference; False - Not Reference
Return type:bool

New in version NX8.0.0.

License requirements: None.

JournalIdentifier

FacetedEdge.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

Name

FacetedEdge.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

FacetedEdge.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns:
Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

FacetedEdge.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner
Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

FacetedEdge.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

FindObject

FacetedEdge.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

GetBody

FacetedEdge.GetBody

Returns the body containing this edge

Signature GetBody()

Returns:
Return type:NXOpen.Facet.FacetedBody

New in version NX8.5.1.

License requirements: None.

GetCurveData

FacetedEdge.GetCurveData

Returns the curve information for the facet edge

Parameter description faceted_edge : The input edge tag for which curve information is required. PNT3_p_t position : Line: Position on Line Circle/Ellipse: Center Point Spline/Intersection-Curve: Start Point of Curve. PNT3_p_t dir_or_end_pt : Line : Direction of the Line Circle: Normal to Plane Axis. Ellipse: Major Axis Spline/Intersection-Curve: End Point. PNT3_p_t x_axis : Circle: Axis from Center to Start Point, Ellipse: Minor Axis Not valid for other types.

double* radius : Circle: Radius Ellipse: Major Radius Not valid for other types.

double* minor_radius : Ellipse: Minor Radius Not valid for other types.

Signature GetCurveData()

Returns:a tuple
Return type:A tuple consisting of (position, dirOrEndPt, xAxis, radius, minorRadius). position is a NXOpen.Point3d. dirOrEndPt is a NXOpen.Point3d. xAxis is a NXOpen.Point3d. radius is a float. minorRadius is a float.

New in version NX8.5.1.

License requirements: None.

GetFaces

FacetedEdge.GetFaces

Returns the faces connected to the edge

Signature GetFaces()

Returns:
Return type:list of NXOpen.Facet.FacetedFace

New in version NX8.5.1.

License requirements: None.

GetLength

FacetedEdge.GetLength

Returns the length of the object

Signature GetLength()

Returns:
Return type:float

New in version NX3.0.0.

License requirements: None.

GetVertices

FacetedEdge.GetVertices

Returns the vertices of the edge.

If the edge is closed, the second vertex is the same as the first.

Signature GetVertices()

Returns:a tuple
Return type:A tuple consisting of (vertex1, vertex2). vertex1 is a NXOpen.Point3d. First vertex in the edge vertex2 is a NXOpen.Point3d. Second vertex in the edge

New in version NX8.5.1.

License requirements: None.

Print

FacetedEdge.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

FacetedEdge.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.