nxopen

Interface DisplayableObject

All Superinterfaces:

IFitTo, INXObject, NXObject, Remote, TaggedObject

All Known Subinterfaces:

Accelerometer, AdapterSignal, AnalysisObject, Anchor, AngularDimension, AngularLimitJoint, AngularSpringJoint, Annotation, ArbitraryTarget, Arc, ArcLengthDimension, ArcSegment, AreaTarget, AutomaticTraceline, Axis, BallJoint, BalloonNote, BaseAngularDimension, BaseArcLengthDimension, BaseArrow, BaseCenterline3d, BaseCenterMark, BaseChamferDimension, BaseConcentricCircleDimension, BaseCustomSymbol, BaseCylindricalDimension, BaseDatum, BaseDatumTarget, BaseDiameterDimension, BaseFcf, BaseFoldedRadiusDimension, BaseFrameBar, BaseHalfSectionLine, BaseHoleDimension, BaseHorizontalDimension, BaselineDimension, BaseNote, BaseParallelDimension, BasePerpendicularDimension, BasePointToPointSectionLine, BaseRadiusDimension, BaseSteppedSectionLine, BaseSurfaceFinish, BaseVerticalDimension, BendTable, Body, BodyContact, BoltCircleCenterline, BoundedGrid, BoundingVolume, BreakingConstraint, Bushing, CAEBody, CAEConnection, CaeDOFSet, CAEEdge, CAEFace, CAEVertex, CAEWeldConnection, Cam, CartesianCoordinateSystem, Centerline, Centerline2d, Centerline3d, CenterMark, ChainDimension, ChamferDimension, ChangeMaterial, CircleCenterline, CircularCenterline, CircularTarget, CollisionBody, CollisionSensor, CompanyProprietaryInformation, Component, Component, ConcentricCircleDimension, Conic, Connector, ControlOutput, ControlPoint, CoordinateNote, CoordinateSystem, Coupler, CouplerCable, CouplerGear, CouplerRckpn, Coupling, CreateFactoryElement, CreateFence, CreateSystem, Curve, CurveContact, CurveContinuity, CurveCurvatureAnalysis, CurveOnCurve, CurveOnCurveJoint, CustomSymbol, CuttingPlaneSymbol, CylindricalCoordinateSystem, CylindricalDimension, CylindricalJoint, Damper, Datum, DatumAxis, DatumPlane, DatumPlaneGrid, DatumTarget, DependentMesh, DeviationGauge, DiameterDimension, DieEngTrimAngleCheck, Dimension, DimensionSet, Direction, DisplayChanger, DisplayedConstraint, DistanceSensor, DraftAnalysis, DraftingAid, DraftingArbitraryTarget, DraftingBody, DraftingCurve, DraftingDatum, DraftingDatumTarget, DraftingFcf, DraftingImage, DraftingLineTarget, DraftingPointTarget, DraftingSurfaceFinish, DrawingRegion, Edge, EdgeDensity, Ellipse, EnterpriseIdentification, EntitySelectionPlane, ExplodedComponent, ExportControl, ExportToDWG, ExternalConnection, ExtractPort, Face, FaceAnalysis, FaceCurvatureAnalysis, FaceDensity, FacetedBody, FacetedEdge, FacetedFace, Fcf, Field, FieldExpression, FieldFormula, FieldLink, FieldLinksTable, FieldReference, FieldTable, FittingPort, FixedJoint, FixturePort, FlexBody, FoldedRadiusDimension, ForceTorqueControl, FormboardFrame, FormboardFrameCGM, FormboardFramePattern, FormboardFrameRectangle, FrameBar, GapArcSegment, GapFlushness, Gdt, Gear, GeneralArcLengthDimension, GeneralChamferDimension, GeneralConcentricCircleDimension, GeneralCoupler, GeneralCustomSymbol, GeneralCylindricalDimension, GeneralDiameterDimension, GeneralFoldedRadiusDimension, GeneralHoleDimension, GeneralHorizontalDimension, GeneralLabel, GeneralMajorAngularDimension, GeneralMinorAngularDimension, GeneralNote, GeneralParallelDimension, GeneralPerpendicularDimension, GeneralRadiusDimension, GeneralVerticalDimension, GenericNote, GenericSensor, GovernmentSecurityInformation, GraphControl, Grid, Group, HalfPictorialSectionLine, HalfSectionLine, Hatch, HighlightLinesAnalysis, HingeJoint, HoleDimension, HoleTable, HorizontalDimension, HorizontalOrdinateDimension, HybridMesh, HydraulicCylinder, HydraulicValve, Hyperbola, IConnection, IConnectionMod, IdSymbol, ImageBase, Inclinometer, InfiniteLine, IntersectionSymbol, Joint, Label, LimitSwitch, Line, LinearLimitJoint, LinearSpringJoint, LineSegment, LineTarget, LineWeld, Link, LinkDriver, LoadTransfer, LocalRadiusAnalysis, LocatorDesignator, MajorAngularDimension, MappedHole, MappedMesh, Marker, MaterialSpecification, MATLABSignalConnection, Mesh, Mesh0d, Mesh1d, Mesh2d, Mesh2dFree, Mesh3d, MeshControl, MeshFollower, MeshMate, MeshPoint, MeshShellFromSolid, MinorAngularDimension, MotionObject, MotionSensor, Motor, MultiPort, Note, NoteBase, ObjectSink, ObjectSource, ObjectTransformer, Offset, OffsetCenterPoint, OrdinateDimension, OrdinateOriginDimension, OrientedSectionLine, Parabola, ParallelDimension, PartIdentification, PathConstraintJoint, PerpendicularDimension, PhysicsConstraint, PhysicsJoint, PictorialSectionLine, PlanarJoint, PlanarShipGrid, Plane, PlaneGrid, PMDCMotor, PmiAngularDimension, PmiArcLengthDimension, PmiAttribute, PmiBaselineDimension, PmiCenterline3d, PmiCenterMark, PmiChainDimension, PmiChamferDimension, PmiConcentricCircleDimension, PmiCustomSymbol, PmiCylindricalDimension, PmiDiameterDimension, PmiFoldedRadiusDimension, PmiHoleDimension, PmiHorizontalDimension, PmiHorizontalOrdinateDimension, PmiInteger, PmiLabel, PmiLineWeld, PmiMajorAngularDimension, PmiMinorAngularDimension, PmiNote, PmiNumber, PmiOrdinateOriginDimension, PmiParallelDimension, PmiPerpendicularDimension, PmiRadiusDimension, PmiString, PmiUrlNote, PmiUserDefined, PmiVerticalDimension, PmiVerticalOrdinateDimension, PmiWave, PneumaticCylinder, PneumaticValve, Point, PointAndAngleSectionLine, PointCloud, PointOnCurve, PointOnCurveJoint, PointOnSurface, PointTarget, PointToPointSectionLine, Polyline, Port, PositionControl, PositionSensor, PreventCollision, PrimitiveMesh, PrimitiveRecipeMesh, ProcessSpecification, ProxyObject, ProxyPort, RackPinion, RadiusDimension, RasterImage, RecipeSurfaceWrap, RectangularTarget, ReferenceSet, Region, Relay, ResultProbe, RevolvedSectionLine, RigidBody, Road, Scalar, ScalarForce, ScalarTorque, ScCollector, ScrewJoint, Section, SectionAnalysisExObject, SectionAnalysisObject, SectionLine, Sensor, SHMSignalConnection, SignalAdapter, SignalConnection, SimBC, SimConstraint, SimLoad, SimpleDraftingAid, SimSimulationObject, Sketch, SketchAlignmentConstraint, SketchAssociativeTrim, SketchConstraint, SketchDimensionalConstraint, SketchedHalfSectionLine, SketchedPointToPointSectionLine, SketchedSteppedSectionLine, SketchG1Constraint, SketchG2Constraint, SketchGeometricConstraint, SketchHelpedDimensionalConstraint, SketchHelpedGeometricConstraint, SketchOffset, SketchPattern, SketchTangentConstraint, SketchTangentToStringConstraint, SlidingJoint, SmartObject, SpecificNote, SpeedControl, SphericalCoordinateSystem, Spline, SplineSegment, SpotWeld, Spring, SpringDamper, SteppedSectionLine, StockOffsetPort, StockPort, StrainGage, SubdivisionMeshBody, SubdivisionMeshEdge, SubdivisionMeshFace, SubdivisionMeshVertex, SurfaceContinuityAnalysis, SurfaceFinish, SurfaceIntersection, SweptMesh, SymmetricalCenterline, Table, TableSection, TargetPoint, TerminalPort, Tire, TitleBlock, Traceline, TransportSurface, UserDefinedObject, VectorForce, VectorTorque, VelocitySensor, VerticalDimension, VerticalOrdinateDimension, ViewingDirectionArrow, ViewingDirectionArrowLabel, VirtualAxis, Weld, WeldRow, Xform

public interface DisplayableObject
extends NXObject, IFitTo

Base class for all objects that are displayable.
This is an abstract class, and cannot be instantiated.

Created in NX3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DisplayableObject.ObjectFont specifies the object font for objects such as lines .
static class	DisplayableObject.ObjectWidth specifies object width for objects such as lines and text .

Nested classes/interfaces inherited from interface nxopen.NXObject

NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData

Method Summary

Modifier and Type	Method and Description
void	blank() Blanks the object.
int	color() Returns the color of the object.
void	highlight() Highlights the object.
boolean	isBlanked() Returns the blank status of this object.
int	layer() Returns the layer that the object is in.
DisplayableObject.ObjectFont	lineFont() Returns the line font of the object.
DisplayableObject.ObjectWidth	lineWidth() Returns the line width of the object.
Point3d	nameLocation() Returns the location of the object's name.
void	redisplayObject() Redisplays the object in all views.
void	removeViewDependency() Remove dependency on all views from an object.
void	setColor(int color) License requirements: None.
void	setLayer(int layer) License requirements: None.
void	setLineFont(DisplayableObject.ObjectFont font) License requirements: None.
void	setLineWidth(DisplayableObject.ObjectWidth width) License requirements: None.
void	setNameLocation(Point3d location) Sets the location of the object's name.
void	unblank() Unblanks the object.
void	unhighlight() Unhighlights the object.

Methods inherited from interface nxopen.NXObject

createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.INXObject

findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName

Method Detail

blank

void blank()
    throws NXException,
           RemoteException

Blanks the object.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

unblank

void unblank()
      throws NXException,
             RemoteException

Unblanks the object.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

isBlanked

boolean isBlanked()
           throws NXException,
                  RemoteException

Returns the blank status of this object.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

highlight

void highlight()
        throws NXException,
               RemoteException

Highlights the object.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

unhighlight

void unhighlight()
          throws NXException,
                 RemoteException

Unhighlights the object.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

color

int color()
   throws NXException,
          RemoteException

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(int) , DisplayModification.newWidth() and DisplayModification.setNewWidth(nxopen.DisplayableObject.ObjectWidth) , DisplayModification.newFont() and DisplayModification.setNewFont(nxopen.DisplayableObject.ObjectFont) and DisplayModification.newLayer() and DisplayModification.setNewLayer(int) . Finally call DisplayModification.apply(nxopen.DisplayableObject[]) 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.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

layer

int layer()
   throws NXException,
          RemoteException

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 color() and setColor(int) . 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.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

lineFont

DisplayableObject.ObjectFont lineFont()
                               throws NXException,
                                      RemoteException

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 color() and setColor(int) . 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.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

lineWidth

DisplayableObject.ObjectWidth lineWidth()
                                 throws NXException,
                                        RemoteException

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 color() and setColor(int) . 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.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setNameLocation

void setNameLocation(Point3d location)
              throws NXException,
                     RemoteException

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.
License requirements: None.

Created in NX3.0.0

Parameters:

location -

Throws:

NXException

RemoteException

nameLocation

Point3d nameLocation()
              throws NXException,
                     RemoteException

Returns the location of the object's name.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setColor

void setColor(int color)
       throws NXException,
              RemoteException

License requirements: None.

Created in NX4.0.0

Parameters:

color -

Throws:

NXException

RemoteException

setLayer

void setLayer(int layer)
       throws NXException,
              RemoteException

License requirements: None.

Created in NX4.0.0

Parameters:

layer -

Throws:

NXException

RemoteException

setLineFont

void setLineFont(DisplayableObject.ObjectFont font)
          throws NXException,
                 RemoteException

License requirements: None.

Created in NX4.0.0

Parameters:

font -

Throws:

NXException

RemoteException

setLineWidth

void setLineWidth(DisplayableObject.ObjectWidth width)
           throws NXException,
                  RemoteException

License requirements: None.

Created in NX4.0.0

Parameters:

width -

Throws:

NXException

RemoteException

redisplayObject

void redisplayObject()
              throws NXException,
                     RemoteException

Redisplays the object in all views. Typically this is used to display an object after its creation.
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

removeViewDependency

void removeViewDependency()
                   throws NXException,
                          RemoteException

Remove dependency on all views from an object.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException