NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder Class Reference

Represents a plane which is used to cut sections on faces or facet bodies
Created in NX7.0.0. More...

Inheritance diagram for NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder:

Public Types
enum	PlaneType {   PlaneTypeXc, PlaneTypeYc, PlaneTypeZc, PlaneTypeView,   PlaneTypePlane }
	The type of different section planes. More...

Public Member Functions
NXOpen::Point3d	Origin ()
	Returns the plane origin Created in NX7.0.0.
NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::PlaneType	Plane ()
	Returns the plane type Created in NX7.0.0.
void	SetOrigin (const NXOpen::Point3d &origin)
	Sets the plane origin Created in NX7.0.0.
void	SetPlane (NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::PlaneType plane)
	Sets the plane type Created in NX7.0.0.
void	SetXAxis (const NXOpen::Vector3d &xAxis)
	Sets the plane X axis Created in NX7.0.0.
void	SetYAxis (const NXOpen::Vector3d &yAxis)
	Sets the plane Y axis Created in NX7.0.0.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
NXOpen::Vector3d	XAxis ()
	Returns the plane X axis Created in NX7.0.0.
NXOpen::Vector3d	YAxis ()
	Returns the plane Y axis Created in NX7.0.0.
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 plane which is used to cut sections on faces or facet bodies
Created in NX7.0.0.

Member Enumeration Documentation

enum NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::PlaneType

The type of different section planes.

Enumerator:

PlaneTypeXc	XC plane.
PlaneTypeYc	YC plane.
PlaneTypeZc	ZC plane.
PlaneTypeView	View plane.
PlaneTypePlane	A user specifed plane.

Member Function Documentation

NXOpen::Point3d NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::Origin

(

)

Returns the plane origin
Created in NX7.0.0.

License requirements : None

NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::PlaneType NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::Plane

(

)

Returns the plane type
Created in NX7.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::SetOrigin

(

const NXOpen::Point3d &

origin

)

Sets the plane origin
Created in NX7.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

origin

origin

void NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::SetPlane

(

NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::PlaneType

plane

)

Sets the plane type
Created in NX7.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

plane

plane

void NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::SetXAxis

(

const NXOpen::Vector3d &

xAxis

)

Sets the plane X axis
Created in NX7.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

xAxis

xaxis

void NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::SetYAxis

(

const NXOpen::Vector3d &

yAxis

)

Sets the plane Y axis
Created in NX7.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

yAxis

yaxis

virtual bool NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::Validate ( )

virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

NXOpen::Vector3d NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::XAxis

(

)

Returns the plane X axis
Created in NX7.0.0.

License requirements : None

NXOpen::Vector3d NXOpen::GeometricAnalysis::SectionAnalysis::SectionPlaneBuilder::YAxis

(

)

Returns the plane Y axis
Created in NX7.0.0.

License requirements : None

---

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

• GeometricAnalysis_SectionAnalysis_SectionPlaneBuilder.hxx