TangentRelationship Object

Derived from: Base Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Components/TangentRelationship.h>

Description

A tangent relationship in a design.

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().
createForAssemblyContext Creates or returns a proxy for the native object - i.e. a new object that represents this object but adds the assembly context defined by the input occurrence.
deleteMe Deletes this tangent relationship.

Properties

Name Description
assemblyContext Returns the assembly occurrence (i.e. the occurrence) of this object in an assembly. This is only valid in the case where this is acting as a proxy in an assembly. Returns null in the case where the object is not in the context of an assembly but is already the native object.
attributes Returns the collection of attributes associated with this tangent relationship.
entityToken Returns a token for the TangentRelationship object. This can be saved and used at a later time with the Design.findEntityByToken method to get back the same tangent relationship.

When using entity tokens it's important to understand that the token string returned for a specific entity can be different over time. However, even if you have two different token strings that were obtained from the same entity, when you use findEntityByToken they will both return the same entity. Because of that you should never compare entity tokens as way to determine what the token represents. Instead, you need to use the findEntityByToken method to get the two entities identified by the tokens and then compare them.
errorOrWarningMessage Returns the error or warning message in the case where the healthState property returns either WarningFeatureHealthState or ErrorFeatureHealthState. Otherwise this property returns an empty string.
faceOne Gets and sets the first BRepFace object that will remain tangent to the set of specified tangent faces.

To set this property, you need to position the timeline marker to immediately before this tangent relationship. This can be accomplished using the following code: thisTangentRelationship.timelineObject.rollTo(True)
healthState Returns the current health state of the tangent relationship.
isSuppressed Gets and sets if this tangent relationship is suppressed.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
name Gets and sets the name of the tangent relationship.
nativeObject The native object is the tangent relationship in the context of the component it was created within.

Returns null in the case where this object is not in the context of an assembly but is already the native object.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
occurrenceOne Returns the first of two occurrences that this tangent relationship defines a relationship between.
occurrenceTwo Returns the second of two occurrences that this tangent relationship defines a relationship between.
parentComponent Returns the parent component that owns this tangent relationship.
tangentFaces Gets and sets a single BRepFace object that is part of the body that faceOne will remain tangent to. All of the faces of the body will be used when computing the tangent relationship.

To set this property, you need to position the timeline marker to immediately before this tangent relationship. This can be accomplished using the following code: thisTangentRelationship.timelineObject.rollTo(True)
timelineObject Returns the timeline object associated with this tangent relationship.

Accessed From

Component.allTangentRelationships, FlatPatternComponent.allTangentRelationships, TangentRelationship.createForAssemblyContext, TangentRelationship.nativeObject, TangentRelationships.add, TangentRelationships.item, TangentRelationships.itemByName

Version

Introduced in version May 2022