NX Open C++ Reference Guide
Public Member Functions
NXOpen::Plane Class Reference

Represents an Plane class. More...

Inheritance diagram for NXOpen::Plane:
NXOpen::SmartObject NXOpen::IPlane NXOpen::ISurface NXOpen::IOrientation NXOpen::DisplayableObject NXOpen::IBasePlane NXOpen::INXObject NXOpen::INXObject NXOpen::NXObject NXOpen::IFitTo NXOpen::INXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

List of all members.

Public Member Functions

void ConvertToSmartPlane ()
 Set PLANE_parms to plane to make it smart plane
Created in NX7.0.0.
NXOpen::PlaneCopySoPlane ()
 Creates an Plane using a datum plane feature.
void DestroyPlane ()
 Destroy the plane object
Created in NX6.0.3.
virtual void Evaluate ()
 Evaluates the plane
Created in NX4.0.0.
virtual NXOpen::ExpressionExpression ()
 Returns the plane expression.
virtual bool Flip ()
 Returns the flip direction of the plane
Created in NX4.0.0.
virtual
NXOpen::PlaneTypes::FrenetSubtype 
FrenetSubtype ()
 Returns the subtype of on curve type of plane fron NX6 onwards.
virtual
NXOpen::PlaneTypes::AlternateType 
GetAlternate ()
 Returns the alternate type.
virtual std::vector
< NXOpen::NXObject * > 
GetGeometry ()
 Returns the geometry.
virtual int GetNumberOfAlternate ()
 Returns the number of alternate solutions.
virtual bool GetReverseSection ()
 Returns the reverse section.
virtual bool GetReverseSide ()
 Returns the reverse side.
virtual NXOpen::Matrix3x3 Matrix ()
 Returns the matrix of the plane
Created in NX7.5.0.
virtual
NXOpen::PlaneTypes::MethodType 
Method ()
 Returns a plane type
Created in NX4.0.0.
virtual NXOpen::Vector3d Normal ()
 Returns the normal of the plane
Created in NX4.0.0.
virtual NXOpen::ExpressionOffsetExpression ()
 Returns the plane offset expression.
virtual bool OffsetFlip ()
 Returns the flip state of the offset direction of the plane
Created in NX7.5.0.
virtual NXOpen::Point3d Origin ()
 Returns the origin of the plane
Created in NX4.0.0.
virtual bool Percent ()
 Returns the arclenth or the percent value
Created in NX4.0.0.
virtual void RemoveOffsetData ()
 Remove all offset data from the plane
Created in NX7.5.0.
virtual void ReplaceExpression (NXOpen::Expression *expTag)
 Replace the expression in on curve plane plane
Created in NX7.5.0.
virtual void ResetExpressionValue ()
 Reset the expression value in on curve plane plane
Created in NX7.5.0.
virtual void SetAlternate (NXOpen::PlaneTypes::AlternateType type)
 Sets the alternate type
Created in NX4.0.0.
virtual void SetExpression (const NXString &valueExpression)
 Sets the plane expression.
virtual void SetFlip (bool flip)
 Flip the direction of the plane
Created in NX4.0.0.
virtual void SetFrenetSubtype (NXOpen::PlaneTypes::FrenetSubtype subtype)
 Sets subtype for a specific plane type where the alternate solution cannot handle.
virtual void SetGeometry (const std::vector< NXOpen::NXObject * > &geom)
 Sets the geometry
Created in NX4.0.0.
virtual void SetMatrix (const NXOpen::Matrix3x3 &matrix)
 Sets the matrix of the plane
Created in NX7.5.0.
virtual void SetMethod (NXOpen::PlaneTypes::MethodType type)
 Sets a plane type
Created in NX4.0.0.
virtual void SetNormal (const NXOpen::Vector3d &normal)
 Sets the normal of the plane
Created in NX4.0.0.
virtual void SetOffsetExpression (const NXString &valueExpression)
 Sets the plane offset expression.
virtual void SetOffsetFlip (bool flip)
 Sets the flip state of the offset direction of the plane
Created in NX7.5.0.
virtual void SetOrigin (const NXOpen::Point3d &origin)
 Sets the origin of the plane
Created in NX4.0.0.
virtual void SetPercent (bool percent)
 Sets the arclenth or the percent value
Created in NX4.0.0.
virtual void SetReverseSection (bool reverseSection)
 Sets the reverse_section
Created in NX4.0.0.
virtual void SetReverseSide (bool reverseSide)
 Sets the reverse side
Created in NX4.0.0.
virtual void SetUpdateOption (NXOpen::SmartObject::UpdateOption update)
 Set to plane update
Created in NX5.0.0.

Detailed Description

Represents an Plane class.


No Creator because of a problem with arrays in APIWRAP

Created in NX4.0.0.


Member Function Documentation

Set PLANE_parms to plane to make it smart plane
Created in NX7.0.0.



License requirements : None

Creates an Plane using a datum plane feature.

Returns:

Created in NX4.0.0.

License requirements : None

Destroy the plane object
Created in NX6.0.3.



License requirements : None

virtual void NXOpen::Plane::Evaluate ( ) [virtual]

Evaluates the plane
Created in NX4.0.0.



License requirements : None

Implements NXOpen::IPlane.

Returns the plane expression.


Created in NX4.0.0.

License requirements : None

Implements NXOpen::IPlane.

virtual bool NXOpen::Plane::Flip ( ) [virtual]

Returns the flip direction of the plane
Created in NX4.0.0.



License requirements : None

Implements NXOpen::IPlane.

Returns the subtype of on curve type of plane fron NX6 onwards.

It is a valid function for and only for on-curve type plane of NX6 onwards.
Created in NX6.0.0.

License requirements : None

Implements NXOpen::IPlane.

Returns the alternate type.

Returns:

Created in NX4.0.0.

License requirements : None

Implements NXOpen::IPlane.

virtual std::vector<NXOpen::NXObject *> NXOpen::Plane::GetGeometry ( ) [virtual]

Returns the geometry.

Returns:

Created in NX4.0.0.

License requirements : None

Implements NXOpen::IPlane.

virtual int NXOpen::Plane::GetNumberOfAlternate ( ) [virtual]

Returns the number of alternate solutions.

Returns:

Created in NX4.0.0.

License requirements : None

Implements NXOpen::IPlane.

virtual bool NXOpen::Plane::GetReverseSection ( ) [virtual]

Returns the reverse section.

Returns:

Created in NX4.0.0.

License requirements : None

Implements NXOpen::IPlane.

virtual bool NXOpen::Plane::GetReverseSide ( ) [virtual]

Returns the reverse side.

Returns:

Created in NX4.0.0.

License requirements : None

Implements NXOpen::IPlane.

Returns the matrix of the plane
Created in NX7.5.0.



License requirements : None

Implements NXOpen::IPlane.

Returns a plane type
Created in NX4.0.0.



License requirements : None

Implements NXOpen::IPlane.

virtual NXOpen::Vector3d NXOpen::Plane::Normal ( ) [virtual]

Returns the normal of the plane
Created in NX4.0.0.



License requirements : None

Implements NXOpen::IPlane.

Returns the plane offset expression.


Created in NX7.5.0.

License requirements : None

Implements NXOpen::IPlane.

virtual bool NXOpen::Plane::OffsetFlip ( ) [virtual]

Returns the flip state of the offset direction of the plane
Created in NX7.5.0.



License requirements : None

Implements NXOpen::IPlane.

virtual NXOpen::Point3d NXOpen::Plane::Origin ( ) [virtual]

Returns the origin of the plane
Created in NX4.0.0.



License requirements : None

Implements NXOpen::IPlane.

virtual bool NXOpen::Plane::Percent ( ) [virtual]

Returns the arclenth or the percent value
Created in NX4.0.0.



License requirements : None

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::RemoveOffsetData ( ) [virtual]

Remove all offset data from the plane
Created in NX7.5.0.



License requirements : None

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::ReplaceExpression ( NXOpen::Expression expTag) [virtual]

Replace the expression in on curve plane plane
Created in NX7.5.0.



License requirements : None

Parameters:
expTagexptag

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::ResetExpressionValue ( ) [virtual]

Reset the expression value in on curve plane plane
Created in NX7.5.0.



License requirements : None

Implements NXOpen::IPlane.

Sets the alternate type
Created in NX4.0.0.



License requirements : None

Parameters:
typetype

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetExpression ( const NXString valueExpression) [virtual]

Sets the plane expression.

Only valid for the following types: PlaneTypes::MethodTypeFrenet or PlaneTypes::MethodTypeDistance .
Created in NX4.0.0.

License requirements : None

Parameters:
valueExpressionoffset value
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetFlip ( bool  flip) [virtual]

Flip the direction of the plane
Created in NX4.0.0.



License requirements : None

Parameters:
flipflip direction

Implements NXOpen::IPlane.

Sets subtype for a specific plane type where the alternate solution cannot handle.

Indeed, this is for frenet type only so far, after the Nissan enhancement in NX6.
Created in NX6.0.0.

License requirements : None

Parameters:
subtypesubtype

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetGeometry ( const std::vector< NXOpen::NXObject * > &  geom) [virtual]

Sets the geometry
Created in NX4.0.0.



License requirements : None

Parameters:
geomgeom

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetMatrix ( const NXOpen::Matrix3x3 matrix) [virtual]

Sets the matrix of the plane
Created in NX7.5.0.



License requirements : None

Parameters:
matrixmatrix

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetMethod ( NXOpen::PlaneTypes::MethodType  type) [virtual]

Sets a plane type
Created in NX4.0.0.



License requirements : None

Parameters:
typetype

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetNormal ( const NXOpen::Vector3d normal) [virtual]

Sets the normal of the plane
Created in NX4.0.0.



License requirements : None

Parameters:
normalnormal

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetOffsetExpression ( const NXString valueExpression) [virtual]

Sets the plane offset expression.


Created in NX7.5.0.

License requirements : None

Parameters:
valueExpressionoffset value
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetOffsetFlip ( bool  flip) [virtual]

Sets the flip state of the offset direction of the plane
Created in NX7.5.0.



License requirements : None

Parameters:
flipoffset flip direction

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetOrigin ( const NXOpen::Point3d origin) [virtual]

Sets the origin of the plane
Created in NX4.0.0.



License requirements : None

Parameters:
originorigin

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetPercent ( bool  percent) [virtual]

Sets the arclenth or the percent value
Created in NX4.0.0.



License requirements : None

Parameters:
percentarclength or percent value

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetReverseSection ( bool  reverseSection) [virtual]

Sets the reverse_section
Created in NX4.0.0.



License requirements : None

Parameters:
reverseSectionreverse section

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetReverseSide ( bool  reverseSide) [virtual]

Sets the reverse side
Created in NX4.0.0.



License requirements : None

Parameters:
reverseSidereverse side

Implements NXOpen::IPlane.

Set to plane update
Created in NX5.0.0.



License requirements : None

Parameters:
updateupdate

Implements NXOpen::IPlane.


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.