DisplayableObject Class

class NXOpen.DisplayableObject

Bases: NXOpen.NXObject, NXOpen.IFitTo

Base class for all objects that are displayable.

This is an abstract class, and cannot be instantiated.

New in version NX3.0.0.

Properties

Property	Description
Color	Returns or sets the color of the object.
IsBlanked	Returns the blank status of this object.
IsOccurrence	Returns whether this object is an occurrence or not.
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 @return A new attribute iterator object
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.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
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.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator @return
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.
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

DisplayableObjectObjectFont Enumeration	specifies the object font for objects such as lines
DisplayableObjectObjectWidth Enumeration	specifies object width for objects such as lines and text

Property Detail

Color

DisplayableObject.Color

Returns or sets the color of the object.

After setting the color, you must call RedisplayObject() in order for the change to take effect. There is a more efficient way to change the color, layer, line font or line width of a object. First call NXOpen.DisplayManager.NewDisplayModification() and then call any combination of set methods for the properties NXOpen.DisplayModification.NewColor`(), NXOpen.DisplayModification.NewWidth`(), NXOpen.DisplayModification.NewFont`() and NXOpen.DisplayModification.NewLayer`(). Finally call NXOpen.DisplayModification.Apply() and TransientObject.Dispose(). This eliminates the need to call RedisplayObject().

NOTE: The set 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.

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

Getter Method

Signature Color()

Returns: Return type:int

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature Color(color)

Parameters:color (int) –

New in version NX4.0.0.

License requirements: None.

IsBlanked

DisplayableObject.IsBlanked

Returns the blank status of this object.

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

Getter Method

Signature IsBlanked()

Returns: Return type:bool

New in version NX3.0.0.

License requirements: None.

IsOccurrence

DisplayableObject.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.

JournalIdentifier

DisplayableObject.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.

Layer

DisplayableObject.Layer

Returns or sets the layer that the object is in.

After setting the layer, you must call RedisplayObject() in order for the change to take effect, except see the comments for NXOpen.DisplayableObject.Color`().

NOTE: The set 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.

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

Getter Method

Signature Layer()

Returns: Return type:int

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature Layer(layer)

Parameters:layer (int) –

New in version NX4.0.0.

License requirements: None.

LineFont

DisplayableObject.LineFont

Returns or sets the line font of the object.

After setting the line font, you must call RedisplayObject() in order for the change to take effect, except see the comments for NXOpen.DisplayableObject.Color`().

NOTE: The set 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.

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

Getter Method

Signature LineFont()

Returns: Return type:NXOpen.DisplayableObjectObjectFont

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature LineFont(font)

Parameters:font (NXOpen.DisplayableObjectObjectFont) –

New in version NX4.0.0.

License requirements: None.

LineWidth

DisplayableObject.LineWidth

Returns or sets the line width of the object.

After setting the line width, you must call RedisplayObject() in order for the change to take effect, except see the comments for NXOpen.DisplayableObject.Color`().

NOTE: The set 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.

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

Getter Method

Signature LineWidth()

Returns: Return type:NXOpen.DisplayableObjectObjectWidth

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature LineWidth(width)

Parameters:width (NXOpen.DisplayableObjectObjectWidth) –

New in version NX4.0.0.

License requirements: None.

Name

DisplayableObject.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.

NameLocation

DisplayableObject.NameLocation

Returns the location of the object’s name.

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

Getter Method

Signature NameLocation()

Returns: Return type:NXOpen.Point3d

New in version NX3.0.0.

License requirements: None.

OwningComponent

DisplayableObject.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

DisplayableObject.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

DisplayableObject.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

Blank

DisplayableObject.Blank

Blanks the object.

Signature Blank()

New in version NX3.0.0.

License requirements: None.

FindObject

DisplayableObject.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.

Highlight

DisplayableObject.Highlight

Highlights the object.

Signature Highlight()

New in version NX3.0.0.

License requirements: None.

Print

DisplayableObject.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

RedisplayObject

DisplayableObject.RedisplayObject

Redisplays the object in all views.

Typically this is used to display an object after its creation.

Signature RedisplayObject()

New in version NX4.0.0.

License requirements: None.

RemoveViewDependency

DisplayableObject.RemoveViewDependency

Remove dependency on all views from an object.

Signature RemoveViewDependency()

New in version NX10.0.0.

License requirements: None.

SetName

DisplayableObject.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.

SetNameLocation

DisplayableObject.SetNameLocation

Sets the location of the object’s name.

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 SetNameLocation(location)

Parameters:location (NXOpen.Point3d) –

New in version NX3.0.0.

License requirements: None.

Unblank

DisplayableObject.Unblank

Unblanks the object.

Signature Unblank()

New in version NX3.0.0.

License requirements: None.

Unhighlight

DisplayableObject.Unhighlight

Unhighlights the object.

Signature Unhighlight()

New in version NX3.0.0.

License requirements: None.