NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.IPlane Interface Reference

Represents an Plane class. More...

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

Public Member Functions

void SetMethod (NXOpen.PlaneTypes.MethodType type)
 Sets a plane type More...
 
void SetExpression (string valueExpression)
 Sets the plane expression. More...
 
void SetFlip (bool flip)
 Flip the direction of the plane More...
 
void SetPercent (bool percent)
 Sets the arclenth or the percent value More...
 
void SetGeometry (NXOpen.NXObject[] geom)
 Sets the geometry More...
 
NXOpen.NXObject[] GetGeometry ()
 Returns the geometry More...
 
void Evaluate ()
 Evaluates the plane More...
 
void SetAlternate (NXOpen.PlaneTypes.AlternateType type)
 Sets the alternate type More...
 
NXOpen.PlaneTypes.AlternateType GetAlternate ()
 Returns the alternate type More...
 
int GetNumberOfAlternate ()
 Returns the number of alternate solutions More...
 
void SetReverseSection (bool reverseSection)
 Sets the reverse_section More...
 
bool GetReverseSection ()
 Returns the reverse section More...
 
void SetFrenetSubtype (NXOpen.PlaneTypes.FrenetSubtype subtype)
 Sets subtype for a specific plane type where the alternate solution cannot handle. More...
 
void SetReverseSide (bool reverseSide)
 Sets the reverse side More...
 
bool GetReverseSide ()
 Returns the reverse side More...
 
void SetUpdateOption (NXOpen.SmartObject.UpdateOption update)
 Set to plane update More...
 
void SetOffsetExpression (string valueExpression)
 Sets the plane offset expression value. More...
 
void SetOffsetFlip (bool flip)
 Sets the flip state of the offset direction of the plane More...
 
void RemoveOffsetData ()
 Remove all offset data from the plane More...
 
void ReplaceExpression (NXOpen.Expression expTag)
 Replace the expression in on curve plane plane More...
 
void ResetExpressionValue ()
 Reset the expression value in on curve plane plane More...
 

Properties

NXOpen.Expression Expression [get]
 Returns the plane expression. More...
 
bool Flip [get]
 Returns the flip direction of the plane More...
 
NXOpen.PlaneTypes.FrenetSubtype FrenetSubtype [get]
 Returns the subtype of on curve type of plane fron NX6 onwards. More...
 
NXOpen.Matrix3x3 Matrix [get, set]
 Returns or sets the matrix of the plane More...
 
NXOpen.PlaneTypes.MethodType Method [get]
 Returns a plane type More...
 
NXOpen.Vector3d Normal [get, set]
 Returns or sets the normal of the plane More...
 
NXOpen.Expression OffsetExpression [get, set]
 Returns or sets the plane offset expression. More...
 
bool OffsetFlip [get]
 Returns the flip state of the offset direction of the plane More...
 
NXOpen.Point3d Origin [get, set]
 Returns or sets the origin of the plane More...
 
bool Percent [get]
 Returns the arclenth or the percent value More...
 

Detailed Description

Represents an Plane class.

Created in NX4.0.0

Member Function Documentation

void NXOpen.IPlane.Evaluate ( )

Evaluates the plane

Created in NX4.0.0

License requirements: None.

Implemented in NXOpen.Plane.

NXOpen.PlaneTypes.AlternateType NXOpen.IPlane.GetAlternate ( )

Returns the alternate type

Created in NX4.0.0

License requirements: None.

Returns

Implemented in NXOpen.Plane.

NXOpen.NXObject [] NXOpen.IPlane.GetGeometry ( )

Returns the geometry

Created in NX4.0.0

License requirements: None.

Returns

Implemented in NXOpen.Plane.

int NXOpen.IPlane.GetNumberOfAlternate ( )

Returns the number of alternate solutions

Created in NX4.0.0

License requirements: None.

Returns

Implemented in NXOpen.Plane.

bool NXOpen.IPlane.GetReverseSection ( )

Returns the reverse section

Created in NX4.0.0

License requirements: None.

Returns

Implemented in NXOpen.Plane.

bool NXOpen.IPlane.GetReverseSide ( )

Returns the reverse side

Created in NX4.0.0

License requirements: None.

Returns

Implemented in NXOpen.Plane.

void NXOpen.IPlane.RemoveOffsetData ( )

Remove all offset data from the plane

Created in NX7.5.0

License requirements: None.

Implemented in NXOpen.Plane.

void NXOpen.IPlane.ReplaceExpression ( NXOpen.Expression  expTag)

Replace the expression in on curve plane plane

Created in NX7.5.0

License requirements: None.

Parameters
expTag

Implemented in NXOpen.Plane.

void NXOpen.IPlane.ResetExpressionValue ( )

Reset the expression value in on curve plane plane

Created in NX7.5.0

License requirements: None.

Implemented in NXOpen.Plane.

void NXOpen.IPlane.SetAlternate ( NXOpen.PlaneTypes.AlternateType  type)

Sets the alternate type

Created in NX4.0.0

License requirements: None.

Parameters
type

Implemented in NXOpen.Plane.

void NXOpen.IPlane.SetExpression ( string  valueExpression)

Sets the plane expression.

Only valid for the following types: PlaneTypes.MethodType.Frenet or PlaneTypes.MethodType.Distance .

Created in NX4.0.0

License requirements: None.

Parameters
valueExpressionoffset value

Implemented in NXOpen.Plane.

void NXOpen.IPlane.SetFlip ( bool  flip)

Flip the direction of the plane

Created in NX4.0.0

License requirements: None.

Parameters
flipflip direction

Implemented in NXOpen.Plane.

void NXOpen.IPlane.SetFrenetSubtype ( NXOpen.PlaneTypes.FrenetSubtype  subtype)

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
subtype

Implemented in NXOpen.Plane.

void NXOpen.IPlane.SetGeometry ( NXOpen.NXObject[]  geom)

Sets the geometry

Created in NX4.0.0

License requirements: None.

Parameters
geom

Implemented in NXOpen.Plane.

void NXOpen.IPlane.SetMethod ( NXOpen.PlaneTypes.MethodType  type)

Sets a plane type

Created in NX4.0.0

License requirements: None.

Parameters
type

Implemented in NXOpen.Plane.

void NXOpen.IPlane.SetOffsetExpression ( string  valueExpression)

Sets the plane offset expression value.

Created in NX7.5.0

License requirements: None.

Parameters
valueExpressionoffset value

Implemented in NXOpen.Plane.

void NXOpen.IPlane.SetOffsetFlip ( bool  flip)

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.

void NXOpen.IPlane.SetPercent ( bool  percent)

Sets the arclenth or the percent value

Created in NX4.0.0

License requirements: None.

Parameters
percentarclength or percent value

Implemented in NXOpen.Plane.

void NXOpen.IPlane.SetReverseSection ( bool  reverseSection)

Sets the reverse_section

Created in NX4.0.0

License requirements: None.

Parameters
reverseSection

Implemented in NXOpen.Plane.

void NXOpen.IPlane.SetReverseSide ( bool  reverseSide)

Sets the reverse side

Created in NX4.0.0

License requirements: None.

Parameters
reverseSide

Implemented in NXOpen.Plane.

void NXOpen.IPlane.SetUpdateOption ( NXOpen.SmartObject.UpdateOption  update)

Set to plane update

Created in NX5.0.0

License requirements: None.

Parameters
update

Property Documentation

NXOpen.Expression NXOpen.IPlane.Expression
get

Returns the plane expression.

Created in NX4.0.0

License requirements: None.

bool NXOpen.IPlane.Flip
get

Returns the flip direction of the plane

Created in NX4.0.0

License requirements: None.

NXOpen.PlaneTypes.FrenetSubtype NXOpen.IPlane.FrenetSubtype
get

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.

NXOpen.Matrix3x3 NXOpen.IPlane.Matrix
getset

Returns or sets the matrix of the plane

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

NXOpen.PlaneTypes.MethodType NXOpen.IPlane.Method
get

Returns a plane type

Created in NX4.0.0

License requirements: None.

NXOpen.Vector3d NXOpen.IPlane.Normal
getset

Returns or sets the normal of the plane

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

NXOpen.Expression NXOpen.IPlane.OffsetExpression
getset

Returns or sets the plane offset expression.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

bool NXOpen.IPlane.OffsetFlip
get

Returns the flip state of the offset direction of the plane

Created in NX7.5.0

License requirements: None.

NXOpen.Point3d NXOpen.IPlane.Origin
getset

Returns or sets the origin of the plane

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

bool NXOpen.IPlane.Percent
get

Returns the arclenth or the percent value

Created in NX4.0.0

License requirements: None.


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