Represents a NXOpen.Display.PlanarShipGrid builder. More...

Inheritance diagram for NXOpen.Display.PlanarShipGridBuilder:

Public Types
enum	IntersectOption { Everything, SelectedObjects, ShipGridAndSelected }
	Settings that indicate how to search for objects that intersect the plane. More...

enum	LabelDisplayOption { ShowAll, ShowEveryOther, ShowEveryThird, ShowEveryFourth, HideAll }
	Settings that indicate what grid lines should be labelled. More...

Public Member Functions
unsafe bool	GetExtent (out NXOpen.Point3d point1, out NXOpen.Point3d point2, out NXOpen.Point3d point3, out NXOpen.Point3d point4)
	Get corner points of the grid extent. More...

unsafe NXOpen.TaggedObject[]	GetIntersectedObjects ()
	Get the objects that were searched to find intersections with the plane. More...

unsafe bool	SetExtent (NXOpen.Point3d point1, NXOpen.Point3d point2, NXOpen.Point3d point3, NXOpen.Point3d point4)
	Set corner points for the grid extent. More...

unsafe void	SetIntersectedObjects (NXOpen.TaggedObject[] intersectedObjects)
	Set the objects that are to be searched to find intersections with the plane. More...

unsafe void	SwitchLabelLocationX ()
	Switch label location in X direction. More...

unsafe void	SwitchLabelLocationY ()
	Switch label location in Y direction. More...

unsafe void	SwitchLabelLocationZ ()
	Switch label location in Z direction. More...

Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...

unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.DatumPlane	BasePlane `[get, set]`
	Returns or sets the base plane where the planar ship grid is created. More...

unsafe NXOpen.Display.PlanarShipGridBuilder.IntersectOption	IntersectType `[get, set]`
	Returns or sets the value that determines how to find objects that intersect the plane. More...

unsafe NXOpen.NXColor	LabelColor `[get, set]`
	Returns or sets the grid line label color. More...

unsafe NXOpen.Display.PlanarShipGridBuilder.LabelDisplayOption	LabelDisplayType `[get, set]`
	Returns or sets the setting that indicates what grid lines are to be labelled. More...

unsafe bool	LabelSettingInheritted `[get, set]`
	Returns or sets the setting that indicates whether the grid line label will inherit the intersected plane's color More...

unsafe NXOpen.NXColor	LineColor `[get, set]`
	Returns or sets the grid line color. More...

unsafe NXOpen.DisplayableObject.ObjectFont	LineFontType `[get, set]`
	Returns or sets the grid line font. More...

unsafe bool	LineSettingInheritted `[get, set]`
	Returns or sets the setting that indicates whether the grid line will inherit the intersected plane's color/font/width. More...

unsafe NXOpen.DisplayableObject.ObjectWidth	LineWidthType `[get, set]`
	Returns or sets the grid line width. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a NXOpen.Display.PlanarShipGrid builder.

To create a new instance of this class, use NXOpen.Display.GridCollection.CreatePlanarShipGridBuilder

Default values.

Property

Value

IntersectType

Everything

LabelDisplayType

ShowAll

LabelSettingInheritted

0

LineFontType

Solid

LineSettingInheritted

1

LineWidthType

Normal

Created in NX8.0.0

Member Enumeration Documentation

enum NXOpen.Display.PlanarShipGridBuilder.IntersectOption

Settings that indicate how to search for objects that intersect the plane.

Enumerator
Everything	all objects will be searched for intersections with the plane
SelectedObjects	only the selected objects will be searched for intersections with the plane
ShipGridAndSelected	intersect the ship grid and selected objects with the plane

enum NXOpen.Display.PlanarShipGridBuilder.LabelDisplayOption

Settings that indicate what grid lines should be labelled.

Enumerator
ShowAll	Display label for every grid line
ShowEveryOther	Display label for every other grid line
ShowEveryThird	Display label for every third grid line
ShowEveryFourth	Display label for every fourth grid line
HideAll	Hide label for all grid lines

Member Function Documentation

unsafe bool NXOpen.Display.PlanarShipGridBuilder.GetExtent	(	out NXOpen.Point3d	point1,
		out NXOpen.Point3d	point2,
		out NXOpen.Point3d	point3,
		out NXOpen.Point3d	point4
	)

inline

Get corner points of the grid extent.

The extent is a rectangle. The four points: point1, point2, point3, point4 are in clockwise or counterclockwise direction.

Created in NX8.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

Parameters

point1	First corner point
point2	Second corner point
point3	Third corner point
point4	Fourth corner point

Returns: Flag indicating whether the corner points are valid

unsafe NXOpen.TaggedObject [] NXOpen.Display.PlanarShipGridBuilder.GetIntersectedObjects ( )

inline

Get the objects that were searched to find intersections with the plane.

Created in NX8.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

Returns: Array of intersected objects

unsafe bool NXOpen.Display.PlanarShipGridBuilder.SetExtent	(	NXOpen.Point3d	point1,
		NXOpen.Point3d	point2,
		NXOpen.Point3d	point3,
		NXOpen.Point3d	point4
	)

inline

Set corner points for the grid extent.

The extent is a rectangle. The four points: point1, point2, point3, point4 should be in clockwise or counterclockwise direction.

Created in NX8.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

Parameters

point1	First corner point
point2	Second corner point
point3	Third corner point
point4	Fourth corner point

Returns: Flag indicating whether the corner points are valid

unsafe void NXOpen.Display.PlanarShipGridBuilder.SetIntersectedObjects ( NXOpen.TaggedObject[] intersectedObjects )

inline

Set the objects that are to be searched to find intersections with the plane.

Created in NX8.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

Parameters

intersectedObjects Array of intersected objects

unsafe void NXOpen.Display.PlanarShipGridBuilder.SwitchLabelLocationX ( )

inline

Switch label location in X direction.

Created in NX8.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

unsafe void NXOpen.Display.PlanarShipGridBuilder.SwitchLabelLocationY ( )

inline

Switch label location in Y direction.

Created in NX8.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

unsafe void NXOpen.Display.PlanarShipGridBuilder.SwitchLabelLocationZ ( )

inline

Switch label location in Z direction.

Created in NX8.0.0

License requirements: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

Property Documentation

unsafe NXOpen.DatumPlane NXOpen.Display.PlanarShipGridBuilder.BasePlane

getset

Returns or sets the base plane where the planar ship grid is created.

Created in NX8.0.0

License requirements to get this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

unsafe NXOpen.Display.PlanarShipGridBuilder.IntersectOption NXOpen.Display.PlanarShipGridBuilder.IntersectType

getset

Returns or sets the value that determines how to find objects that intersect the plane.

Created in NX8.0.0

License requirements to get this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

unsafe NXOpen.NXColor NXOpen.Display.PlanarShipGridBuilder.LabelColor

getset

Returns or sets the grid line label color.

Only used if the color is not inherited from the intersected plane.

Created in NX8.0.0

License requirements to get this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

unsafe NXOpen.Display.PlanarShipGridBuilder.LabelDisplayOption NXOpen.Display.PlanarShipGridBuilder.LabelDisplayType

getset

Returns or sets the setting that indicates what grid lines are to be labelled.

Created in NX8.0.0

License requirements to get this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

unsafe bool NXOpen.Display.PlanarShipGridBuilder.LabelSettingInheritted

getset

Returns or sets the setting that indicates whether the grid line label will inherit the intersected plane's color

Created in NX8.0.0

License requirements to get this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

unsafe NXOpen.NXColor NXOpen.Display.PlanarShipGridBuilder.LineColor

getset

Returns or sets the grid line color.

Only used if the color is not inherited from the intersected plane.

Created in NX8.0.0

License requirements to get this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

unsafe NXOpen.DisplayableObject.ObjectFont NXOpen.Display.PlanarShipGridBuilder.LineFontType

getset

Returns or sets the grid line font.

Only used if the font is not inherited from the intersected plane.

Created in NX8.0.0

License requirements to get this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

unsafe bool NXOpen.Display.PlanarShipGridBuilder.LineSettingInheritted

getset

Returns or sets the setting that indicates whether the grid line will inherit the intersected plane's color/font/width.

Created in NX8.0.0

License requirements to get this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

unsafe NXOpen.DisplayableObject.ObjectWidth NXOpen.Display.PlanarShipGridBuilder.LineWidthType

getset

Returns or sets the grid line width.

Only used if the width is not inherited from the intersected plane.

Created in NX8.0.0

License requirements to get this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement") OR nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

The documentation for this class was generated from the following file:

Display_PlanarShipGridBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation