NX Open C++ Reference Guide
Public Types | Public Member Functions
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::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::Mesh NXOpen::CAE::MeshControl NXOpen::CAE::ResponseSimulation::Sensor NXOpen::CAE::ResponseSimulation::StrainGage NXOpen::CAE::SimBC NXOpen::DatumAxis NXOpen::DatumPlane NXOpen::Display::EntitySelectionPlane NXOpen::Display::Grid 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::Mechatronics::CollisionBody NXOpen::Mechatronics::CollisionSensor NXOpen::Mechatronics::ExternalConnection NXOpen::Mechatronics::GraphControl NXOpen::Mechatronics::ObjectSink NXOpen::Mechatronics::ObjectSource NXOpen::Mechatronics::PhysicsConstraint NXOpen::Mechatronics::PhysicsJoint NXOpen::Mechatronics::RigidBody NXOpen::Mechatronics::TransportSurface NXOpen::Motion::Marker NXOpen::Motion::MotionObject NXOpen::Positioning::DisplayedConstraint NXOpen::ReferenceSet NXOpen::Routing::FormboardFrame NXOpen::ScCollector NXOpen::Section NXOpen::Sketch NXOpen::SmartObject NXOpen::Traceline NXOpen::UserDefinedObjects::UserDefinedObject

List of all members.

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 }
 specifies object width for objects such as lines and text
Created in NX3.0.0. More...

Public Member Functions

void Blank ()
 Blanks the object.
int Color ()
 Returns the color of the object.
void Highlight ()
 Highlights the object.
bool IsBlanked ()
 Returns the blank status of this object.
int Layer ()
 Returns the layer that the object is in.
NXOpen::DisplayableObject::ObjectFont LineFont ()
 Returns the line font of the object.
NXOpen::DisplayableObject::ObjectWidth LineWidth ()
 Returns the line width of the object.
NXOpen::Point3d NameLocation ()
 Returns the location of the object's name.
void RedisplayObject ()
 Redisplays the object in all views.
void SetColor (int color)
 Sets the color of the object.
void SetLayer (int layer)
 Sets the layer that the object is in.
void SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
 Sets the line font of the object.
void SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
 Sets the line width of the object.
void SetNameLocation (const NXOpen::Point3d &location)
 Sets the location of the object's name.
void Unblank ()
 Unblanks the object.
void Unhighlight ()
 Unhighlights the object.

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:
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


Member Function Documentation

Blanks the object.


Created in NX3.0.0.

License requirements : None

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 DisplayManager::NewDisplayModification and then call any combination of set methods for the properties DisplayModification::NewColor and DisplayModification::SetNewColor , DisplayModification::NewWidth and DisplayModification::SetNewWidth , DisplayModification::NewFont and DisplayModification::SetNewFont and DisplayModification::NewLayer and DisplayModification::SetNewLayer . Finally call DisplayModification::Apply and TransientObject::Dispose . This eliminates the need to call RedisplayObject .
Created in NX3.0.0.

License requirements : None

Highlights the object.


Created in NX3.0.0.

License requirements : None

Returns the blank status of this object.


Created in NX3.0.0.

License requirements : None

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 DisplayableObject::Color and DisplayableObject::SetColor .
Created in NX3.0.0.

License requirements : None

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 DisplayableObject::Color and DisplayableObject::SetColor .
Created in NX3.0.0.

License requirements : None

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 DisplayableObject::Color and DisplayableObject::SetColor .
Created in NX3.0.0.

License requirements : None

Returns the location of the object's name.


Created in NX3.0.0.

License requirements : None

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

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 DisplayManager::NewDisplayModification and then call any combination of set methods for the properties DisplayModification::NewColor and DisplayModification::SetNewColor , DisplayModification::NewWidth and DisplayModification::SetNewWidth , DisplayModification::NewFont and DisplayModification::SetNewFont and DisplayModification::NewLayer and DisplayModification::SetNewLayer . Finally call DisplayModification::Apply and TransientObject::Dispose . This eliminates the need to call RedisplayObject .
Created in NX4.0.0.

License requirements : None

Parameters:
colorcolor

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 DisplayableObject::Color and DisplayableObject::SetColor .
Created in NX4.0.0.

License requirements : None

Parameters:
layerlayer

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 DisplayableObject::Color and DisplayableObject::SetColor .
Created in NX4.0.0.

License requirements : None

Parameters:
fontfont

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 DisplayableObject::Color and DisplayableObject::SetColor .
Created in NX4.0.0.

License requirements : None

Parameters:
widthwidth

Sets the location of the object's name.


Created in NX3.0.0.

License requirements : None

Parameters:
locationlocation

Unblanks the object.


Created in NX3.0.0.

License requirements : None

Unhighlights the object.


Created in NX3.0.0.

License requirements : None


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