public interface PlanarShipGridBuilder extends Builder
PlanarShipGrid
builder. GridCollection.createPlanarShipGridBuilder(nxopen.display.PlanarShipGrid)
Property | Value |
---|---|
IntersectType | Everything |
LabelDisplayType | ShowAll |
LabelSettingInheritted | 0 |
LineFontType | Solid |
LineSettingInheritted | 1 |
LineWidthType | Normal |
Modifier and Type | Interface and Description |
---|---|
static class |
PlanarShipGridBuilder.ExtentData
This class holds the data returned from
getExtent() |
static class |
PlanarShipGridBuilder.IntersectOption
Settings that indicate how to search for objects that intersect the plane.
|
static class |
PlanarShipGridBuilder.LabelDisplayOption
Settings that indicate what grid lines should be labelled.
|
Modifier and Type | Method and Description |
---|---|
DatumPlane |
basePlane()
Returns the base plane where the planar ship grid is created.
|
PlanarShipGridBuilder.ExtentData |
getExtent()
Get corner points of the grid extent.
|
TaggedObject[] |
getIntersectedObjects()
Get the objects that were searched to find intersections with the plane.
|
PlanarShipGridBuilder.IntersectOption |
intersectType()
Returns the value that determines how to find objects that intersect the plane.
|
NXColor |
labelColor()
Returns the grid line label color.
|
PlanarShipGridBuilder.LabelDisplayOption |
labelDisplayType()
Returns the setting that indicates what grid lines are to be labelled.
|
boolean |
labelSettingInheritted()
Returns the setting that indicates whether the grid line label will inherit the intersected plane's color
License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") . |
NXColor |
lineColor()
Returns the grid line color.
|
DisplayableObject.ObjectFont |
lineFontType()
Returns the grid line font.
|
boolean |
lineSettingInheritted()
Returns the setting that indicates whether the grid line will inherit the intersected plane's color/font/width.
|
DisplayableObject.ObjectWidth |
lineWidthType()
Returns the grid line width.
|
void |
setBasePlane(DatumPlane basePlane)
License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") . |
boolean |
setExtent(Point3d point1,
Point3d point2,
Point3d point3,
Point3d point4)
Set corner points for the grid extent.
|
void |
setIntersectedObjects(TaggedObject[] intersectedObjects)
Set the objects that are to be searched to find intersections with the plane.
|
void |
setIntersectType(PlanarShipGridBuilder.IntersectOption intersectType)
License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") . |
void |
setLabelColor(NXColor labelColor)
License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") . |
void |
setLabelDisplayType(PlanarShipGridBuilder.LabelDisplayOption labelDisplayType)
License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") . |
void |
setLabelSettingInheritted(boolean labelSettingInheritted)
License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") . |
void |
setLineColor(NXColor lineColor)
License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") . |
void |
setLineFontType(DisplayableObject.ObjectFont lineFontType)
License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") . |
void |
setLineSettingInheritted(boolean lineSettingInheritted)
License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") . |
void |
setLineWidthType(DisplayableObject.ObjectWidth lineWidthType)
License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design") . |
void |
switchLabelLocationX()
Switch label location in X direction.
|
void |
switchLabelLocationY()
Switch label location in Y direction.
|
void |
switchLabelLocationZ()
Switch label location in Z direction.
|
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
DatumPlane basePlane() throws NXException, RemoteException
NXException
RemoteException
void setBasePlane(DatumPlane basePlane) throws NXException, RemoteException
basePlane
- NXException
RemoteException
PlanarShipGridBuilder.ExtentData getExtent() throws NXException, RemoteException
NXException
RemoteException
boolean setExtent(Point3d point1, Point3d point2, Point3d point3, Point3d point4) throws NXException, RemoteException
point1
- First corner pointpoint2
- Second corner pointpoint3
- Third corner pointpoint4
- Fourth corner pointNXException
RemoteException
PlanarShipGridBuilder.IntersectOption intersectType() throws NXException, RemoteException
NXException
RemoteException
void setIntersectType(PlanarShipGridBuilder.IntersectOption intersectType) throws NXException, RemoteException
intersectType
- NXException
RemoteException
TaggedObject[] getIntersectedObjects() throws NXException, RemoteException
NXException
RemoteException
void setIntersectedObjects(TaggedObject[] intersectedObjects) throws NXException, RemoteException
intersectedObjects
- Array of intersected objectsNXException
RemoteException
boolean lineSettingInheritted() throws NXException, RemoteException
NXException
RemoteException
void setLineSettingInheritted(boolean lineSettingInheritted) throws NXException, RemoteException
lineSettingInheritted
- NXException
RemoteException
NXColor lineColor() throws NXException, RemoteException
NXException
RemoteException
void setLineColor(NXColor lineColor) throws NXException, RemoteException
lineColor
- NXException
RemoteException
DisplayableObject.ObjectWidth lineWidthType() throws NXException, RemoteException
NXException
RemoteException
void setLineWidthType(DisplayableObject.ObjectWidth lineWidthType) throws NXException, RemoteException
lineWidthType
- NXException
RemoteException
DisplayableObject.ObjectFont lineFontType() throws NXException, RemoteException
NXException
RemoteException
void setLineFontType(DisplayableObject.ObjectFont lineFontType) throws NXException, RemoteException
lineFontType
- NXException
RemoteException
PlanarShipGridBuilder.LabelDisplayOption labelDisplayType() throws NXException, RemoteException
NXException
RemoteException
void setLabelDisplayType(PlanarShipGridBuilder.LabelDisplayOption labelDisplayType) throws NXException, RemoteException
labelDisplayType
- NXException
RemoteException
boolean labelSettingInheritted() throws NXException, RemoteException
NXException
RemoteException
void setLabelSettingInheritted(boolean labelSettingInheritted) throws NXException, RemoteException
labelSettingInheritted
- NXException
RemoteException
NXColor labelColor() throws NXException, RemoteException
NXException
RemoteException
void setLabelColor(NXColor labelColor) throws NXException, RemoteException
labelColor
- NXException
RemoteException
void switchLabelLocationX() throws NXException, RemoteException
NXException
RemoteException
void switchLabelLocationY() throws NXException, RemoteException
NXException
RemoteException
void switchLabelLocationZ() throws NXException, RemoteException
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.