Represents a Display::PlanarShipGrid builder. More...

Inheritance diagram for NXOpen::Display::PlanarShipGridBuilder:

Public Types
enum	IntersectOption { IntersectOptionEverything, IntersectOptionSelectedObjects, IntersectOptionShipGridAndSelected }
	Settings that indicate how to search for objects that intersect the plane. More...

enum	LabelDisplayOption { LabelDisplayOptionShowAll, LabelDisplayOptionShowEveryOther, LabelDisplayOptionShowEveryThird, LabelDisplayOptionShowEveryFourth, LabelDisplayOptionHideAll }
	Settings that indicate what grid lines should be labelled. More...

Public Member Functions
NXOpen::DatumPlane *	BasePlane ()
	Returns the base plane where the planar ship grid is created.

bool	GetExtent (NXOpen::Point3d point1, NXOpen::Point3d point2, NXOpen::Point3d point3, NXOpen::Point3d point4)
	Get corner points of the grid extent.

std::vector < NXOpen::TaggedObject * >	GetIntersectedObjects ()
	Get the objects that were searched to find intersections with the plane.

NXOpen::Display::PlanarShipGridBuilder::IntersectOption	IntersectType ()
	Returns the value that determines how to find objects that intersect the plane.

NXOpen::NXColor *	LabelColor ()
	Returns the grid line label color.

NXOpen::Display::PlanarShipGridBuilder::LabelDisplayOption	LabelDisplayType ()
	Returns the setting that indicates what grid lines are to be labelled.

bool	LabelSettingInheritted ()
	Returns the setting that indicates whether the grid line label will inherit the intersected plane's color Created in NX8.0.0.

NXOpen::NXColor *	LineColor ()
	Returns the grid line color.

NXOpen::DisplayableObject::ObjectFont	LineFontType ()
	Returns the grid line font.

bool	LineSettingInheritted ()
	Returns the setting that indicates whether the grid line will inherit the intersected plane's color/font/width.

NXOpen::DisplayableObject::ObjectWidth	LineWidthType ()
	Returns the grid line width.

void	SetBasePlane (NXOpen::DatumPlane *basePlane)
	Sets the base plane where the planar ship grid is created.

bool	SetExtent (const NXOpen::Point3d &point1, const NXOpen::Point3d &point2, const NXOpen::Point3d &point3, const NXOpen::Point3d &point4)
	Set corner points for the grid extent.

void	SetIntersectedObjects (const std::vector< NXOpen::TaggedObject * > &intersectedObjects)
	Set the objects that are to be searched to find intersections with the plane.

void	SetIntersectType (NXOpen::Display::PlanarShipGridBuilder::IntersectOption intersectType)
	Sets the value that determines how to find objects that intersect the plane.

void	SetLabelColor (NXOpen::NXColor *labelColor)
	Sets the grid line label color.

void	SetLabelDisplayType (NXOpen::Display::PlanarShipGridBuilder::LabelDisplayOption labelDisplayType)
	Sets the setting that indicates what grid lines are to be labelled.

void	SetLabelSettingInheritted (bool labelSettingInheritted)
	Sets the setting that indicates whether the grid line label will inherit the intersected plane's color Created in NX8.0.0.

void	SetLineColor (NXOpen::NXColor *lineColor)
	Sets the grid line color.

void	SetLineFontType (NXOpen::DisplayableObject::ObjectFont lineFontType)
	Sets the grid line font.

void	SetLineSettingInheritted (bool lineSettingInheritted)
	Sets the setting that indicates whether the grid line will inherit the intersected plane's color/font/width.

void	SetLineWidthType (NXOpen::DisplayableObject::ObjectWidth lineWidthType)
	Sets the grid line width.

void	SwitchLabelLocationX ()
	Switch label location in X direction.

void	SwitchLabelLocationY ()
	Switch label location in Y direction.

void	SwitchLabelLocationZ ()
	Switch label location in Z direction.

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

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

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Display::PlanarShipGrid builder.

To create a new instance of this class, use 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:

IntersectOptionEverything	all objects will be searched for intersections with the plane
IntersectOptionSelectedObjects	only the selected objects will be searched for intersections with the plane
IntersectOptionShipGridAndSelected	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:

LabelDisplayOptionShowAll	Display label for every grid line.
LabelDisplayOptionShowEveryOther	Display label for every other grid line.
LabelDisplayOptionShowEveryThird	Display label for every third grid line.
LabelDisplayOptionShowEveryFourth	Display label for every fourth grid line.
LabelDisplayOptionHideAll	Hide label for all grid lines.

Member Function Documentation

NXOpen::DatumPlane* NXOpen::Display::PlanarShipGridBuilder::BasePlane ( )

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

Created in NX8.0.0.

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

bool NXOpen::Display::PlanarShipGridBuilder::GetExtent	(	NXOpen::Point3d *	point1,
		NXOpen::Point3d *	point2,
		NXOpen::Point3d *	point3,
		NXOpen::Point3d *	point4
	)

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.

Returns: Flag indicating whether the corner points are valid
Created in NX8.0.0.

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

std::vector<NXOpen::TaggedObject *> NXOpen::Display::PlanarShipGridBuilder::GetIntersectedObjects ( )

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

Returns: Array of intersected objects
Created in NX8.0.0.

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

NXOpen::Display::PlanarShipGridBuilder::IntersectOption NXOpen::Display::PlanarShipGridBuilder::IntersectType ( )

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

Created in NX8.0.0.

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

NXOpen::NXColor* NXOpen::Display::PlanarShipGridBuilder::LabelColor ( )

Returns the grid line label color.

Only used if the color is not inherited from the intersected plane.
Created in NX8.0.0.

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

NXOpen::Display::PlanarShipGridBuilder::LabelDisplayOption NXOpen::Display::PlanarShipGridBuilder::LabelDisplayType ( )

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

Created in NX8.0.0.

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

bool NXOpen::Display::PlanarShipGridBuilder::LabelSettingInheritted ( )

Returns the setting that indicates whether the grid line label will inherit the intersected plane's color
Created in NX8.0.0.

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

NXOpen::NXColor* NXOpen::Display::PlanarShipGridBuilder::LineColor ( )

Returns the grid line color.

Only used if the color is not inherited from the intersected plane.
Created in NX8.0.0.

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

NXOpen::DisplayableObject::ObjectFont NXOpen::Display::PlanarShipGridBuilder::LineFontType ( )

Returns the grid line font.

Only used if the font is not inherited from the intersected plane.
Created in NX8.0.0.

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

bool NXOpen::Display::PlanarShipGridBuilder::LineSettingInheritted ( )

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

Created in NX8.0.0.

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

NXOpen::DisplayableObject::ObjectWidth NXOpen::Display::PlanarShipGridBuilder::LineWidthType ( )

Returns the grid line width.

Only used if the width is not inherited from the intersected plane.
Created in NX8.0.0.

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

void NXOpen::Display::PlanarShipGridBuilder::SetBasePlane ( NXOpen::DatumPlane * basePlane )

Sets the base plane where the planar ship grid is created.

Created in NX8.0.0.

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

Parameters

basePlane baseplane

bool NXOpen::Display::PlanarShipGridBuilder::SetExtent	(	const NXOpen::Point3d &	point1,
		const NXOpen::Point3d &	point2,
		const NXOpen::Point3d &	point3,
		const NXOpen::Point3d &	point4
	)

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.

Returns: Flag indicating whether the corner points are valid
Created in NX8.0.0.

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

void NXOpen::Display::PlanarShipGridBuilder::SetIntersectedObjects ( const std::vector< NXOpen::TaggedObject * > & intersectedObjects )

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

Created in NX8.0.0.

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

Parameters

intersectedObjects Array of intersected objects

void NXOpen::Display::PlanarShipGridBuilder::SetIntersectType ( NXOpen::Display::PlanarShipGridBuilder::IntersectOption intersectType )

Sets the value that determines how to find objects that intersect the plane.

Created in NX8.0.0.

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

Parameters

intersectType intersecttype

void NXOpen::Display::PlanarShipGridBuilder::SetLabelColor ( NXOpen::NXColor * labelColor )

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 : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

Parameters

labelColor labelcolor

void NXOpen::Display::PlanarShipGridBuilder::SetLabelDisplayType ( NXOpen::Display::PlanarShipGridBuilder::LabelDisplayOption labelDisplayType )

Sets the setting that indicates what grid lines are to be labelled.

Created in NX8.0.0.

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

Parameters

labelDisplayType labeldisplaytype

void NXOpen::Display::PlanarShipGridBuilder::SetLabelSettingInheritted ( bool labelSettingInheritted )

Sets the setting that indicates whether the grid line label will inherit the intersected plane's color
Created in NX8.0.0.

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

Parameters

labelSettingInheritted labelsettinginheritted

void NXOpen::Display::PlanarShipGridBuilder::SetLineColor ( NXOpen::NXColor * lineColor )

Sets the grid line color.

Only used if the color is not inherited from the intersected plane.
Created in NX8.0.0.

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

Parameters

lineColor linecolor

void NXOpen::Display::PlanarShipGridBuilder::SetLineFontType ( NXOpen::DisplayableObject::ObjectFont lineFontType )

Sets the grid line font.

Only used if the font is not inherited from the intersected plane.
Created in NX8.0.0.

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

Parameters

lineFontType linefonttype

void NXOpen::Display::PlanarShipGridBuilder::SetLineSettingInheritted ( bool lineSettingInheritted )

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 : nx_ship_detail ("Ship Detail Design") OR nx_ship_basic ("Ship Basic Design")

Parameters

lineSettingInheritted linesettinginheritted

void NXOpen::Display::PlanarShipGridBuilder::SetLineWidthType ( NXOpen::DisplayableObject::ObjectWidth lineWidthType )

Sets the grid line width.

Only used if the width is not inherited from the intersected plane.
Created in NX8.0.0.

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

Parameters

lineWidthType linewidthtype

void NXOpen::Display::PlanarShipGridBuilder::SwitchLabelLocationX ( )

Switch label location in X direction.

Created in NX8.0.0.

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

void NXOpen::Display::PlanarShipGridBuilder::SwitchLabelLocationY ( )

Switch label location in Y direction.

Created in NX8.0.0.

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

void NXOpen::Display::PlanarShipGridBuilder::SwitchLabelLocationZ ( )

Switch label location in Z direction.

Created in NX8.0.0.

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

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation