NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Display::PlanarShipGridBuilder Class Reference

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

Inheritance diagram for NXOpen::Display::PlanarShipGridBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  IntersectOption { IntersectOptionEverything, IntersectOptionSelectedObjects }
 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::DatumPlaneBasePlane ()
 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::NXColorLabelColor ()
 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::NXColorLineColor ()
 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.

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

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

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

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")

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:
point1First corner point
point2Second corner point
point3Third corner point
point4Fourth corner point

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")

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")

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")

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")

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")

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")

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")

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")

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")

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:
basePlanebaseplane
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:
point1First corner point
point2Second corner point
point3Third corner point
point4Fourth 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:
intersectedObjectsArray of intersected objects

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:
intersectTypeintersecttype

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:
labelColorlabelcolor

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:
labelDisplayTypelabeldisplaytype

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:
labelSettingInherittedlabelsettinginheritted

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:
lineColorlinecolor

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:
lineFontTypelinefonttype

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:
lineSettingInherittedlinesettinginheritted

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:
lineWidthTypelinewidthtype

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")

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")

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.