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

Represents an Plane class. More...

Inheritance diagram for NXOpen::IPlane:
NXOpen::IBasePlane NXOpen::INXObject NXOpen::Plane

List of all members.

Public Member Functions

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

Detailed Description

Represents an Plane class.


Created in NX4.0.0.


Member Function Documentation

virtual void NXOpen::IPlane::Evaluate ( ) [pure virtual]

Evaluates the plane
Created in NX4.0.0.



License requirements : None

Implemented in NXOpen::Plane.

virtual NXOpen::Expression* NXOpen::IPlane::Expression ( ) [pure virtual]

Returns the plane expression.


Created in NX4.0.0.

License requirements : None

Implemented in NXOpen::Plane.

virtual bool NXOpen::IPlane::Flip ( ) [pure virtual]

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



License requirements : None

Implemented in NXOpen::Plane.

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

Implemented in NXOpen::Plane.

Returns the alternate type.

Returns:

Created in NX4.0.0.

License requirements : None

Implemented in NXOpen::Plane.

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

Returns the geometry.

Returns:

Created in NX4.0.0.

License requirements : None

Implemented in NXOpen::Plane.

virtual int NXOpen::IPlane::GetNumberOfAlternate ( ) [pure virtual]

Returns the number of alternate solutions.

Returns:

Created in NX4.0.0.

License requirements : None

Implemented in NXOpen::Plane.

virtual bool NXOpen::IPlane::GetReverseSection ( ) [pure virtual]

Returns the reverse section.

Returns:

Created in NX4.0.0.

License requirements : None

Implemented in NXOpen::Plane.

virtual bool NXOpen::IPlane::GetReverseSide ( ) [pure virtual]

Returns the reverse side.

Returns:

Created in NX4.0.0.

License requirements : None

Implemented in NXOpen::Plane.

virtual NXOpen::Matrix3x3 NXOpen::IPlane::Matrix ( ) [pure virtual]

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



License requirements : None

Implemented in NXOpen::Plane.

Returns a plane type
Created in NX4.0.0.



License requirements : None

Implemented in NXOpen::Plane.

virtual NXOpen::Vector3d NXOpen::IPlane::Normal ( ) [pure virtual]

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



License requirements : None

Implemented in NXOpen::Plane.

Returns the plane offset expression.


Created in NX7.5.0.

License requirements : None

Implemented in NXOpen::Plane.

virtual bool NXOpen::IPlane::OffsetFlip ( ) [pure virtual]

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



License requirements : None

Implemented in NXOpen::Plane.

virtual NXOpen::Point3d NXOpen::IPlane::Origin ( ) [pure virtual]

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



License requirements : None

Implemented in NXOpen::Plane.

virtual bool NXOpen::IPlane::Percent ( ) [pure virtual]

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



License requirements : None

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::RemoveOffsetData ( ) [pure virtual]

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



License requirements : None

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::ReplaceExpression ( NXOpen::Expression expTag) [pure virtual]

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



License requirements : None

Parameters:
expTagexptag

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::ResetExpressionValue ( ) [pure virtual]

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



License requirements : None

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::SetAlternate ( NXOpen::PlaneTypes::AlternateType  type) [pure virtual]

Sets the alternate type
Created in NX4.0.0.



License requirements : None

Parameters:
typetype

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::SetExpression ( const NXString valueExpression) [pure 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.

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::SetFlip ( bool  flip) [pure virtual]

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



License requirements : None

Parameters:
flipflip direction

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::SetFrenetSubtype ( NXOpen::PlaneTypes::FrenetSubtype  subtype) [pure virtual]

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

Implemented in NXOpen::Plane.

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

Sets the geometry
Created in NX4.0.0.



License requirements : None

Parameters:
geomgeom

Implemented in NXOpen::Plane.

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

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



License requirements : None

Parameters:
matrixmatrix

Implemented in NXOpen::Plane.

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

Sets a plane type
Created in NX4.0.0.



License requirements : None

Parameters:
typetype

Implemented in NXOpen::Plane.

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

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



License requirements : None

Parameters:
normalnormal

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::SetOffsetExpression ( const NXString valueExpression) [pure 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.

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::SetOffsetFlip ( bool  flip) [pure virtual]

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



License requirements : None

Parameters:
flipoffset flip direction

Implemented in NXOpen::Plane.

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

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



License requirements : None

Parameters:
originorigin

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::SetPercent ( bool  percent) [pure virtual]

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



License requirements : None

Parameters:
percentarclength or percent value

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::SetReverseSection ( bool  reverseSection) [pure virtual]

Sets the reverse_section
Created in NX4.0.0.



License requirements : None

Parameters:
reverseSectionreverse section

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::SetReverseSide ( bool  reverseSide) [pure virtual]

Sets the reverse side
Created in NX4.0.0.



License requirements : None

Parameters:
reverseSidereverse side

Implemented in NXOpen::Plane.

virtual void NXOpen::IPlane::SetUpdateOption ( NXOpen::SmartObject::UpdateOption  update) [pure virtual]

Set to plane update
Created in NX5.0.0.



License requirements : None

Parameters:
updateupdate

Implemented in NXOpen::Plane.


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