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

Base class for all objects that are displayable. More...

Inheritance diagram for NXOpen::DisplayableObject:
NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject NXOpen::AnimationDesigner::Contact NXOpen::AnimationDesigner::CurveOnCurveJoint NXOpen::AnimationDesigner::CylindricalJoint NXOpen::AnimationDesigner::FixedJoint NXOpen::AnimationDesigner::Gear NXOpen::AnimationDesigner::Measure NXOpen::AnimationDesigner::MechanicalCam NXOpen::AnimationDesigner::PointOnCurveJoint NXOpen::AnimationDesigner::PositionMotor NXOpen::AnimationDesigner::RackPinion NXOpen::AnimationDesigner::RevoluteJoint NXOpen::AnimationDesigner::RigidGroup NXOpen::AnimationDesigner::SliderJoint NXOpen::AnimationDesigner::SpeedMotor NXOpen::AnimationDesigner::SphericalJoint NXOpen::Annotations::Annotation NXOpen::Annotations::Table NXOpen::Assemblies::Component NXOpen::Body NXOpen::CAE::CAEBody NXOpen::CAE::CAEConnection NXOpen::CAE::CaeDOFSet NXOpen::CAE::CAEEdge NXOpen::CAE::CAEFace NXOpen::CAE::CAEVertex NXOpen::CAE::Connections::IConnection NXOpen::CAE::Mesh NXOpen::CAE::MeshControl NXOpen::CAE::ResponseSimulation::Sensor NXOpen::CAE::ResponseSimulation::StrainGage NXOpen::CAE::SelectionRecipe NXOpen::CAE::SimBC NXOpen::DatumAxis NXOpen::DatumPlane NXOpen::Diagramming::BaseObject NXOpen::Display::EntitySelectionPlane NXOpen::Display::Grid NXOpen::Display::ImageBase NXOpen::Display::PointCloud NXOpen::Drawings::DraftingBody NXOpen::Drawings::DraftingCurve NXOpen::Drawings::DrawingRegion NXOpen::Drawings::SectionLine NXOpen::Edge NXOpen::Face NXOpen::Facet::FacetedBody NXOpen::Facet::FacetedEdge NXOpen::Facet::FacetedFace NXOpen::Fields::Field NXOpen::GeometricAnalysis::AnalysisObject NXOpen::Group NXOpen::Layout2d::Component NXOpen::LineDesigner::CreateFactoryElement NXOpen::LineDesigner::CreateFence NXOpen::LineDesigner::CreateSystem NXOpen::LineDesigner::ExportToDWG NXOpen::Mechatronics::Accelerometer NXOpen::Mechatronics::AdapterSignal NXOpen::Mechatronics::CollisionBody NXOpen::Mechatronics::CollisionSensor NXOpen::Mechatronics::DisplayChanger NXOpen::Mechatronics::DistanceSensor NXOpen::Mechatronics::ExternalConnection NXOpen::Mechatronics::GenericSensor NXOpen::Mechatronics::GraphControl NXOpen::Mechatronics::HydraulicCylinder NXOpen::Mechatronics::HydraulicValve NXOpen::Mechatronics::Inclinometer NXOpen::Mechatronics::LimitSwitch NXOpen::Mechatronics::MATLABSignalConnection NXOpen::Mechatronics::ObjectSink NXOpen::Mechatronics::ObjectSource NXOpen::Mechatronics::ObjectTransformer NXOpen::Mechatronics::PhysicsConstraint NXOpen::Mechatronics::PhysicsJoint NXOpen::Mechatronics::PneumaticCylinder NXOpen::Mechatronics::PneumaticValve NXOpen::Mechatronics::PositionSensor NXOpen::Mechatronics::ProxyObject NXOpen::Mechatronics::Relay NXOpen::Mechatronics::RigidBody NXOpen::Mechatronics::SHMSignalConnection NXOpen::Mechatronics::SignalAdapter NXOpen::Mechatronics::SignalConnection NXOpen::Mechatronics::SignalMappingConnection NXOpen::Mechatronics::Tracer NXOpen::Mechatronics::VelocitySensor NXOpen::Mechatronics::VirtualAxis NXOpen::Mfg::Mlp::Blank NXOpen::Mfg::Mlp::InProcessFeature NXOpen::Mfg::Mlp::Line NXOpen::Mfg::Mlp::MachineTool NXOpen::Mfg::Mlp::MachiningFeature NXOpen::Mfg::Mlp::Operation NXOpen::Mfg::Mlp::Part NXOpen::Mfg::Mlp::PartFeature NXOpen::Mfg::Mlp::ProcessPlan NXOpen::Mfg::Mlp::ProcessSetup NXOpen::Mfg::Mlp::Product NXOpen::Mfg::Mlp::ToolAssembly NXOpen::Mfg::Mlp::ToolSet NXOpen::Mfg::Mlp::Workpiece NXOpen::Motion::Marker NXOpen::Motion::MotionObject NXOpen::Motion::SubmechanismPositioner NXOpen::Positioning::DisplayedConstraint NXOpen::ReferenceSet NXOpen::Routing::FormboardFrame NXOpen::ScCollector NXOpen::Section NXOpen::Sketch NXOpen::SketchConstraint NXOpen::SmartObject NXOpen::SubdivisionMeshBody NXOpen::SubdivisionMeshEdge NXOpen::SubdivisionMeshFace NXOpen::SubdivisionMeshVertex NXOpen::Traceline NXOpen::UserDefinedObjects::UserDefinedObject

Public Types

enum  ObjectFont {
  ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline,
  ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed
}
 specifies the object font for objects such as lines
Created in NX3.0.0. More...
 
enum  ObjectWidth {
  ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5,
  ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive,
  ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine
}
 specifies object width for objects such as lines and text
Created in NX3.0.0. More...
 
- Public Types inherited from NXOpen::NXObject
enum  AttributeType {
  AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger,
  AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference,
  AttributeTypeAny = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
 Specifies the format of the date and time attribute. More...
 

Public Member Functions

void Blank ()
 Blanks the object. More...
 
int Color ()
 Returns the color of the object. More...
 
void Highlight ()
 Highlights the object. More...
 
bool IsBlanked ()
 Returns the blank status of this object. More...
 
int Layer ()
 Returns the layer that the object is in. More...
 
NXOpen::DisplayableObject::ObjectFont LineFont ()
 Returns the line font of the object. More...
 
NXOpen::DisplayableObject::ObjectWidth LineWidth ()
 Returns the line width of the object. More...
 
NXOpen::Point3d NameLocation ()
 Returns the location of the object's name. More...
 
void RedisplayObject ()
 Redisplays the object in all views. More...
 
void RemoveViewDependency ()
 Remove dependency on all views from an object. More...
 
void SetColor (int color)
 Sets the color of the object. More...
 
void SetLayer (int layer)
 Sets the layer that the object is in. More...
 
void SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
 Sets the line font of the object. More...
 
void SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
 Sets the line width of the object. More...
 
void SetNameLocation (const NXOpen::Point3d &location)
 Sets the location of the object's name. More...
 
void Unblank ()
 Unblanks the object. More...
 
void Unhighlight ()
 Unhighlights the object. More...
 
- Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIteratorCreateAttributeIterator ()
 Create an attribute iterator. More...
 
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
 Deletes all attributes of a specific type. More...
 
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...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
void DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator
Created in NX8.0.0. More...
 
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...
 
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (const char *journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
bool GetBooleanUserAttribute (const NXString &title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
bool GetBooleanUserAttribute (const char *title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
int GetIntegerAttribute (const NXString &title)
 Gets an integer attribute by title. More...
 
int GetIntegerAttribute (const char *title)
 Gets an integer attribute by title. More...
 
int GetIntegerUserAttribute (const NXString &title, int index)
 Gets an integer attribute by Title and array Index. More...
 
int GetIntegerUserAttribute (const char *title, int index)
 Gets an integer attribute by Title and array Index. More...
 
bool GetNextUserAttribute (NXOpen::AttributeIterator *iterator, NXOpen::NXObject::AttributeInformation *info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
NXString GetPdmReferenceAttributeValue (const NXString &attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
NXString GetPdmReferenceAttributeValue (const char *attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
double GetRealAttribute (const NXString &title)
 Gets a real attribute by title. More...
 
double GetRealAttribute (const char *title)
 Gets a real attribute by title. More...
 
double GetRealUserAttribute (const NXString &title, int index)
 Gets a real attribute by Title and array Index. More...
 
double GetRealUserAttribute (const char *title, int index)
 Gets a real attribute by Title and array Index. More...
 
NXString GetReferenceAttribute (const NXString &title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetReferenceAttribute (const char *title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetStringAttribute (const NXString &title)
 Gets a string attribute value by title. More...
 
NXString GetStringAttribute (const char *title)
 Gets a string attribute value by title. More...
 
NXString GetStringUserAttribute (const NXString &title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetStringUserAttribute (const char *title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
 Gets a time attribute by title. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
 Gets a time attribute by title. More...
 
NXString GetTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXString GetTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::AttributeInformation GetUserAttribute (const NXString &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...
 
NXOpen::NXObject::AttributeInformation GetUserAttribute (const char *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...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const NXString &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...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const char *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...
 
NXString GetUserAttributeAsString (const NXString &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...
 
NXString GetUserAttributeAsString (const char *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...
 
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
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...
 
bool GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
bool GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
std::vector
< 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...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
std::vector< NXStringGetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
int GetUserAttributeSize (const NXString &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...
 
int GetUserAttributeSize (const char *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...
 
std::vector< NXOpen::NXObject * > GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
bool HasUserAttribute (NXOpen::AttributeIterator *iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator. More...
 
bool HasUserAttribute (const NXString &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...
 
bool HasUserAttribute (const char *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...
 
virtual bool IsOccurrence ()
 Returns whether this object is an occurrence or not. More...
 
virtual NXString JournalIdentifier ()
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual NXString Name ()
 Returns the custom name of the object. More...
 
virtual
NXOpen::Assemblies::Component
OwningComponent ()
 Returns the owning component, if this object is an occurrence. More...
 
virtual NXOpen::BasePartOwningPart ()
 Returns the owning part of this object
Created in NX3.0.0. More...
 
virtual void Print ()
 Prints a representation of this object to the system log file. More...
 
virtual NXOpen::INXObjectPrototype ()
 Returns the prototype of this object if it is an occurrence. More...
 
void SetAttribute (const NXString &title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const char *title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const char *title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const char *title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const char *title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const char *title, const char *value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const char *title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const NXString &title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetAttribute (const char *title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
virtual void SetName (const NXString &name)
 Sets the custom name of the object. More...
 
virtual void SetName (const char *name)
 Sets the custom name of the object. More...
 
void SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetPdmReferenceAttribute (const char *attributeTitle, const char *attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const char *title, const char *value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const char *title, const char *value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
void SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Base class for all objects that are displayable.


This is an abstract class, and cannot be instantiated.

Created in NX3.0.0.

Member Enumeration Documentation

specifies the object font for objects such as lines
Created in NX3.0.0.


Enumerator
ObjectFontSolid 

solid

ObjectFontDashed 

dashed

ObjectFontPhantom 

phantom

ObjectFontCenterline 

centerline

ObjectFontDotted 

dotted

ObjectFontLongDashed 

long dashed

ObjectFontDottedDashed 

dotted dashed

specifies object width for objects such as lines and text
Created in NX3.0.0.


Enumerator
ObjectWidthNormal 

normal

ObjectWidthThick 

thick

ObjectWidthThin 

thin

ObjectWidthOne 

one

ObjectWidthTwo 

two

ObjectWidthThree 

three

ObjectWidthFour 

four

ObjectWidthFive 

five

ObjectWidthSix 

six

ObjectWidthSeven 

seven

ObjectWidthEight 

eight

ObjectWidthNine 

nine

Member Function Documentation

void NXOpen::DisplayableObject::Blank ( )

Blanks the object.


Created in NX3.0.0.

License requirements : None

int NXOpen::DisplayableObject::Color ( )

Returns 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 and NXOpen::DisplayModification::SetNewColor , NXOpen::DisplayModification::NewWidth and NXOpen::DisplayModification::SetNewWidth , NXOpen::DisplayModification::NewFont and NXOpen::DisplayModification::SetNewFont and NXOpen::DisplayModification::NewLayer and NXOpen::DisplayModification::SetNewLayer . Finally call NXOpen::DisplayModification::Apply . 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.
Created in NX3.0.0.

License requirements : None

void NXOpen::DisplayableObject::Highlight ( )

Highlights the object.


Created in NX3.0.0.

License requirements : None

bool NXOpen::DisplayableObject::IsBlanked ( )

Returns the blank status of this object.


Created in NX3.0.0.

License requirements : None

int NXOpen::DisplayableObject::Layer ( )

Returns 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 and NXOpen::DisplayableObject::SetColor .

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.
Created in NX3.0.0.

License requirements : None

NXOpen::DisplayableObject::ObjectFont NXOpen::DisplayableObject::LineFont ( )

Returns 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 and NXOpen::DisplayableObject::SetColor .

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.
Created in NX3.0.0.

License requirements : None

NXOpen::DisplayableObject::ObjectWidth NXOpen::DisplayableObject::LineWidth ( )

Returns 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 and NXOpen::DisplayableObject::SetColor .

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.
Created in NX3.0.0.

License requirements : None

NXOpen::Point3d NXOpen::DisplayableObject::NameLocation ( )

Returns the location of the object's name.


Created in NX3.0.0.

License requirements : None

void NXOpen::DisplayableObject::RedisplayObject ( )

Redisplays the object in all views.

Typically this is used to display an object after its creation.
Created in NX4.0.0.

License requirements : None

void NXOpen::DisplayableObject::RemoveViewDependency ( )

Remove dependency on all views from an object.


Created in NX10.0.0.

License requirements : None

void NXOpen::DisplayableObject::SetColor ( int  color)

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 and NXOpen::DisplayModification::SetNewColor , NXOpen::DisplayModification::NewWidth and NXOpen::DisplayModification::SetNewWidth , NXOpen::DisplayModification::NewFont and NXOpen::DisplayModification::SetNewFont and NXOpen::DisplayModification::NewLayer and NXOpen::DisplayModification::SetNewLayer . Finally call NXOpen::DisplayModification::Apply . 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.
Created in NX4.0.0.

License requirements : None

Parameters
colorcolor
void NXOpen::DisplayableObject::SetLayer ( int  layer)

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 and NXOpen::DisplayableObject::SetColor .

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.
Created in NX4.0.0.

License requirements : None

Parameters
layerlayer
void NXOpen::DisplayableObject::SetLineFont ( NXOpen::DisplayableObject::ObjectFont  font)

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 and NXOpen::DisplayableObject::SetColor .

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.
Created in NX4.0.0.

License requirements : None

Parameters
fontfont
void NXOpen::DisplayableObject::SetLineWidth ( NXOpen::DisplayableObject::ObjectWidth  width)

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 and NXOpen::DisplayableObject::SetColor .

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.
Created in NX4.0.0.

License requirements : None

Parameters
widthwidth
void NXOpen::DisplayableObject::SetNameLocation ( const NXOpen::Point3d location)

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.
Created in NX3.0.0.

License requirements : None

Parameters
locationlocation
void NXOpen::DisplayableObject::Unblank ( )

Unblanks the object.


Created in NX3.0.0.

License requirements : None

void NXOpen::DisplayableObject::Unhighlight ( )

Unhighlights the object.


Created in NX3.0.0.

License requirements : None


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