Represents a NXOpen.Features.ShipDesign.ShipCoordinates builder More...

Inheritance diagram for NXOpen.Features.ShipDesign.ShipCoordinatesBuilder:

Public Types
enum	Selection { Point, Component }
	Represents the options to select point or component. More...

enum	XDirectionType { Forward, Aft }
	Represents X-frame direction. More...

enum	YDirectionType { Port, Starboard }
	Represents Y-frame direction. More...

enum	ZDirectionType { Above, Below }
	Represents Z-frame direction. More...

Public Member Functions
unsafe void	CreatePointByCoordinates ()
	Creates a standard point. More...

unsafe void	CycleRoutingPorts ()
	Cycles through the ports on the selected routing component. More...

unsafe void	EvaluatePointInformation (NXOpen.Point3d position)
	Evaluates the point per position and and sets them into ShipCoordinatesBuilder builder. More...

unsafe void	EvaluateSinglePortInformation (int portIndex)
	Evaluates the Nth ports information and sets them into ShipCoordinatesBuilder builder, the index starts from 1 and should be equal or less than number of ports. More...

unsafe void	GetPorts (out NXOpen.TaggedObject[] ports)
	Gets ports in component. More...

unsafe void	SetPosition (NXOpen.Point3d position)
	Sets the point information into the ShipCoordinate builder and a standard point will be created according to the position. 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 double	AbsXValue `[get, set]`
	Returns or sets the X value in absolute coordinate system. More...

unsafe double	AbsYValue `[get, set]`
	Returns or sets the Y value in absolute coordinate system. More...

unsafe double	AbsZValue `[get, set]`
	Returns or sets the Z value in absolute coordinate system. More...

unsafe double	DeltaX `[get, set]`
	Returns or sets the delta value whic is distance between current point and previous point along X-direction. More...

unsafe double	DeltaY `[get, set]`
	Returns or sets the delta value whic is distance between current point and previous point along Y-direction. More...

unsafe double	DeltaZ `[get, set]`
	Returns or sets the delta value which is distance between current point and previous point long Z-direction. More...

unsafe NXOpen.Point	Point `[get, set]`
	Returns or sets the point to define ship coordinates. More...

unsafe NXOpen.SelectDisplayableObject	RoutingComponent `[get]`
	Returns the routing component. More...

unsafe NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.Selection	SelectionType `[get, set]`
	Returns or sets the selection type. More...

unsafe NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.XDirectionType	XDirection `[get, set]`
	Returns or sets the X-frame direction. More...

unsafe double	XDistance `[get, set]`
	Returns or sets the distance along X-direction. More...

unsafe string	XFrameOption `[get, set]`
	Returns or sets the X-frame option. More...

unsafe NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.YDirectionType	YDirection `[get, set]`
	Returns or sets the Y-frame direction. More...

unsafe double	YDistance `[get, set]`
	Returns or sets the distance along Y-direction. More...

unsafe string	YFrameOption `[get, set]`
	Returns or sets the Y-frame option. More...

unsafe NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.ZDirectionType	ZDirection `[get, set]`
	Returns or sets the Z-frame direction. More...

unsafe double	ZDistance `[get, set]`
	Returns or sets the distance along Z-direction. More...

unsafe string	ZFrameOption `[get, set]`
	Returns or sets the Z-frame option. More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

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

Detailed Description

Represents a NXOpen.Features.ShipDesign.ShipCoordinates builder

To create a new instance of this class, use NXOpen.Features.ShipCollection.CreateShipCoordinatesBuilder

Default values.

Property

Value

AbsXValue

0

AbsYValue

0

AbsZValue

0

DeltaX

0

DeltaY

0

DeltaZ

0

XDirection

Forward

XDistance

0

YDirection

Port

YDistance

0

ZDirection

Above

ZDistance

0

Created in NX8.0.0

Member Enumeration Documentation

enum NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.Selection

Represents the options to select point or component.

Enumerator
Point	Allows point selection.
Component	Allows routing component selection.

enum NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.XDirectionType

Represents X-frame direction.

Enumerator
Forward
Aft

enum NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.YDirectionType

Represents Y-frame direction.

Enumerator
Port
Starboard

enum NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.ZDirectionType

Represents Z-frame direction.

Enumerator
Above
Below

Member Function Documentation

unsafe void NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.CreatePointByCoordinates ( )

inline

Creates a standard point.

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") OR routing_base ("Routing Basic")

unsafe void NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.CycleRoutingPorts ( )

inline

Cycles through the ports on the selected routing component.

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") OR routing_base ("Routing Basic")

unsafe void NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.EvaluatePointInformation ( NXOpen.Point3d position )

inline

Evaluates the point per position and and sets them into ShipCoordinatesBuilder builder.

Created in NX8.5.0

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

Parameters

position

unsafe void NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.EvaluateSinglePortInformation ( int portIndex )

inline

Evaluates the Nth ports information and sets them into ShipCoordinatesBuilder builder, the index starts from 1 and should be equal or less than number of ports.

Created in NX8.5.0

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

Parameters

portIndex

unsafe void NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.GetPorts ( out NXOpen.TaggedObject[] ports )

inline

Gets ports in component.

Created in NX8.5.0

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

Parameters

ports

unsafe void NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.SetPosition ( NXOpen.Point3d position )

inline

Sets the point information into the ShipCoordinate builder and a standard point will be created according to the position.

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") OR routing_base ("Routing Basic")

Parameters

position

Property Documentation

unsafe double NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.AbsXValue

getset

Returns or sets the X value in absolute coordinate system.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe double NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.AbsYValue

getset

Returns or sets the Y value in absolute coordinate system.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe double NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.AbsZValue

getset

Returns or sets the Z value in absolute coordinate system.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe double NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.DeltaX

getset

Returns or sets the delta value whic is distance between current point and previous point along X-direction.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe double NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.DeltaY

getset

Returns or sets the delta value whic is distance between current point and previous point along Y-direction.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe double NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.DeltaZ

getset

Returns or sets the delta value which is distance between current point and previous point long Z-direction.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe NXOpen.Point NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.Point

getset

Returns or sets the point to define ship coordinates.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe NXOpen.SelectDisplayableObject NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.RoutingComponent

get

Returns the routing component.

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") OR routing_base ("Routing Basic")

unsafe NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.Selection NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.SelectionType

getset

Returns or sets the selection type.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.XDirectionType NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.XDirection

getset

Returns or sets the X-frame direction.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe double NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.XDistance

getset

Returns or sets the distance along X-direction.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe string NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.XFrameOption

getset

Returns or sets the X-frame option.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.YDirectionType NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.YDirection

getset

Returns or sets the Y-frame direction.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe double NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.YDistance

getset

Returns or sets the distance along Y-direction.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe string NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.YFrameOption

getset

Returns or sets the Y-frame option.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.ZDirectionType NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.ZDirection

getset

Returns or sets the Z-frame direction.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe double NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.ZDistance

getset

Returns or sets the distance along Z-direction.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

unsafe string NXOpen.Features.ShipDesign.ShipCoordinatesBuilder.ZFrameOption

getset

Returns or sets the Z-frame option.

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") OR routing_base ("Routing Basic")

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") OR routing_base ("Routing Basic")

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

Features_ShipDesign_ShipCoordinatesBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation