nxopen.layout2d

Interface Component

All Superinterfaces:

DisplayableObject, IFitTo, INXObject, NXObject, Remote, TaggedObject

public interface Component
extends DisplayableObject

Represents the Component object.
To create or edit an instance of this class, use DefineComponentBuilder

Created in NX10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Component.AnchorPointData This class holds the data returned from getAnchorPoint()
static class	Component.TransformData This class holds the data returned from getTransform()

Nested classes/interfaces inherited from interface nxopen.DisplayableObject

DisplayableObject.ObjectFont, DisplayableObject.ObjectWidth

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	activate() Activates the component.
Sketch	activateInIsolation() Activates the component while in edit in isolation task environment and returns component internal sketch License requirements: nx_layout ("NX Layout") .
void	addExistingCurves(DisplayableObject[] curves) Add an array of specified curves from top level sketch to this component License requirements: nx_layout ("NX Layout") .
void	deactivate() Deactivates the component.
void	exitActivate() Exits the component active status without committing the changes.
Component.AnchorPointData	getAnchorPoint() Gets the anchor point of a component if it exist License requirements: nx_layout ("NX Layout") .
ComponentDefinition	getDefinition() Gets the component definition of a component License requirements: nx_layout ("NX Layout") .
Layout2dDefinitionLocation	getDefinitionLocation() Gets the location of the component definition License requirements: nx_layout ("NX Layout") .
String	getDefinitionName() Gets the component definition name of a component License requirements: nx_layout ("NX Layout") .
String	getDefinitionPath() Gets the path of the component definition License requirements: nx_layout ("NX Layout") .
DisplayableObject[]	getMembers(Layout2dComponentMemberType memberType) Returns an array of specified members in this component License requirements: nx_layout ("NX Layout") .
Component.TransformData	getTransform() Gets the absolute transform of a component, as a rotation matrix and a translation vector License requirements: nx_layout ("NX Layout") .
boolean	isActive() Returns the active state of 2D Component.
boolean	lockUpdateStatus() Returns the lock update status of 2D Component.
void	setLockUpdateStatus(boolean lock) License requirements: nx_layout ("NX Layout") .
void	setTransform(Matrix3x3 rotation, Vector3d translation) Sets the absolute transform on a component, given a rotation matrix and a translation vector License requirements: nx_layout ("NX Layout") .
void	transform(Matrix3x3 rotation, Vector3d translation) Transforms the component given a rotation matrix and a translation vector License requirements: nx_layout ("NX Layout") .
void	update() Updates the component and all of its sub components.

Methods inherited from interface nxopen.DisplayableObject

blank, color, highlight, isBlanked, layer, lineFont, lineWidth, nameLocation, redisplayObject, removeViewDependency, setColor, setLayer, setLineFont, setLineWidth, setNameLocation, unblank, unhighlight

Methods inherited from interface nxopen.NXObject

createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, 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, setPdmReferenceAttribute, 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

activate

void activate()
       throws NXException,
              RemoteException

Activates the component.
License requirements: nx_layout ("NX Layout")

Created in NX10.0.0

Throws:

NXException

RemoteException

deactivate

void deactivate()
         throws NXException,
                RemoteException

Deactivates the component.
License requirements: nx_layout ("NX Layout")

Created in NX10.0.0

Throws:

NXException

RemoteException

isActive

boolean isActive()
          throws NXException,
                 RemoteException

Returns the active state of 2D Component.
License requirements: drafting ("DRAFTING")

Created in NX10.0.0

Throws:

NXException

RemoteException

update

void update()
     throws NXException,
            RemoteException

Updates the component and all of its sub components.
License requirements: nx_layout ("NX Layout")

Created in NX10.0.0

Throws:

NXException

RemoteException

lockUpdateStatus

boolean lockUpdateStatus()
                  throws NXException,
                         RemoteException

Returns the lock update status of 2D Component.
License requirements: drafting ("DRAFTING")

Created in NX10.0.0

Throws:

NXException

RemoteException

setLockUpdateStatus

void setLockUpdateStatus(boolean lock)
                  throws NXException,
                         RemoteException

License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Parameters:

lock -

Throws:

NXException

RemoteException

exitActivate

void exitActivate()
           throws NXException,
                  RemoteException

Exits the component active status without committing the changes.
License requirements: nx_layout ("NX Layout")

Created in NX10.0.0

Throws:

NXException

RemoteException

getMembers

DisplayableObject[] getMembers(Layout2dComponentMemberType memberType)
                        throws NXException,
                               RemoteException

Returns an array of specified members in this component
License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Parameters:

memberType -

Throws:

NXException

RemoteException

transform

void transform(Matrix3x3 rotation,
               Vector3d translation)
        throws NXException,
               RemoteException

Transforms the component given a rotation matrix and a translation vector
License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Parameters:

rotation -

translation -

Throws:

NXException

RemoteException

setTransform

void setTransform(Matrix3x3 rotation,
                  Vector3d translation)
           throws NXException,
                  RemoteException

Sets the absolute transform on a component, given a rotation matrix and a translation vector
License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Parameters:

rotation -

translation -

Throws:

NXException

RemoteException

getTransform

Component.TransformData getTransform()
                              throws NXException,
                                     RemoteException

Gets the absolute transform of a component, as a rotation matrix and a translation vector
License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Throws:

NXException

RemoteException

addExistingCurves

void addExistingCurves(DisplayableObject[] curves)
                throws NXException,
                       RemoteException

Add an array of specified curves from top level sketch to this component
License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Parameters:

curves -

Throws:

NXException

RemoteException

getDefinition

ComponentDefinition getDefinition()
                           throws NXException,
                                  RemoteException

Gets the component definition of a component
License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Throws:

NXException

RemoteException

getAnchorPoint

Component.AnchorPointData getAnchorPoint()
                                  throws NXException,
                                         RemoteException

Gets the anchor point of a component if it exist
License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Throws:

NXException

RemoteException

getDefinitionName

String getDefinitionName()
                  throws NXException,
                         RemoteException

Gets the component definition name of a component
License requirements: nx_layout ("NX Layout")
.
Created in NX10.0.0

Throws:

NXException

RemoteException

getDefinitionPath

String getDefinitionPath()
                  throws NXException,
                         RemoteException

Gets the path of the component definition
License requirements: nx_layout ("NX Layout")
.
Created in NX11.0.0

Throws:

NXException

RemoteException

getDefinitionLocation

Layout2dDefinitionLocation getDefinitionLocation()
                                          throws NXException,
                                                 RemoteException

Gets the location of the component definition
License requirements: nx_layout ("NX Layout")
.
Created in NX11.0.0

Throws:

NXException

RemoteException

activateInIsolation

Sketch activateInIsolation()
                    throws NXException,
                           RemoteException

Activates the component while in edit in isolation task environment and returns component internal sketch
License requirements: nx_layout ("NX Layout")
.
Created in NX11.0.0

Throws:

NXException

RemoteException