NXOpen::Plane Class Reference

Represents an Plane class. More...

Inheritance diagram for NXOpen::Plane:

Public Member Functions
void	ConvertToSmartPlane ()
	Convert a fixed plane to a smart plane object to allow applying constraints to the plane. More...
NXOpen::Plane *	CopyPlane ()
	Returns a new Plane object which is based on this plane's parameters. More...
NXOpen::Plane *	CopySoPlane ()
	Creates an Plane using a datum plane feature. More...
void	DestroyPlane ()
	Destroy the plane object Created in NX6.0.3. More...
void	EditFixedPlane (const NXOpen::Point3d &origin, const NXOpen::Matrix3x3 &matrix)
	Edit a fixed plane object with a new origin and matrix. More...
virtual void	Evaluate ()
	Evaluates the plane Created in NX4.0.0. More...
virtual NXOpen::Expression *	Expression ()
	Returns the plane expression. More...
virtual bool	Flip ()
	Returns the flip direction of the plane Created in NX4.0.0. More...
virtual NXOpen::PlaneTypes::FrenetSubtype	FrenetSubtype ()
	Returns the subtype of on curve type of plane fron NX6 onwards. More...
virtual NXOpen::PlaneTypes::AlternateType	GetAlternate ()
	Returns the alternate type. More...
virtual std::vector < NXOpen::NXObject * >	GetGeometry ()
	Returns the geometry. More...
virtual int	GetNumberOfAlternate ()
	Returns the number of alternate solutions. More...
virtual bool	GetReverseSection ()
	Returns the reverse section. More...
virtual bool	GetReverseSide ()
	Returns the reverse side. More...
virtual NXOpen::Matrix3x3	Matrix ()
	Returns the matrix of the plane Created in NX7.5.0. More...
virtual NXOpen::PlaneTypes::MethodType	Method ()
	Returns a plane type Created in NX4.0.0. More...
virtual NXOpen::Vector3d	Normal ()
	Returns the normal of the plane Created in NX4.0.0. More...
virtual NXOpen::Expression *	OffsetExpression ()
	Returns the plane offset expression. More...
virtual bool	OffsetFlip ()
	Returns the flip state of the offset direction of the plane Created in NX7.5.0. More...
virtual NXOpen::Point3d	Origin ()
	Returns the origin of the plane Created in NX4.0.0. More...
virtual bool	Percent ()
	Returns the arclenth or the percent value Created in NX4.0.0. More...
virtual void	RemoveOffsetData ()
	Remove all offset data from the plane Created in NX7.5.0. More...
virtual void	ReplaceExpression (NXOpen::Expression *expTag)
	Replace the expression in on curve plane plane Created in NX7.5.0. More...
virtual void	ResetExpressionValue ()
	Reset the expression value in on curve plane plane Created in NX7.5.0. More...
virtual void	SetAlternate (NXOpen::PlaneTypes::AlternateType type)
	Sets the alternate type Created in NX4.0.0. More...
virtual void	SetExpression (const NXString &valueExpression)
	Sets the plane expression. More...
virtual void	SetExpression (const char *valueExpression)
	Sets the plane expression. More...
virtual void	SetFlip (bool flip)
	Flip the direction of the plane Created in NX4.0.0. More...
virtual void	SetFrenetSubtype (NXOpen::PlaneTypes::FrenetSubtype subtype)
	Sets subtype for a specific plane type where the alternate solution cannot handle. More...
virtual void	SetGeometry (const std::vector< NXOpen::NXObject * > &geom)
	Sets the geometry Created in NX4.0.0. More...
virtual void	SetMatrix (const NXOpen::Matrix3x3 &matrix)
	Sets the matrix of the plane Created in NX7.5.0. More...
virtual void	SetMethod (NXOpen::PlaneTypes::MethodType type)
	Sets a plane type Created in NX4.0.0. More...
virtual void	SetNormal (const NXOpen::Vector3d &normal)
	Sets the normal of the plane Created in NX4.0.0. More...
virtual void	SetOffsetExpression (const NXString &valueExpression)
	Sets the plane offset expression value. More...
virtual void	SetOffsetExpression (const char *valueExpression)
	Sets the plane offset expression value. More...
virtual void	SetOffsetExpression (NXOpen::Expression *valueExpression)
	Sets the plane offset expression. More...
virtual void	SetOffsetFlip (bool flip)
	Sets the flip state of the offset direction of the plane Created in NX7.5.0. More...
virtual void	SetOrigin (const NXOpen::Point3d &origin)
	Sets the origin of the plane Created in NX4.0.0. More...
virtual void	SetPercent (bool percent)
	Sets the arclenth or the percent value Created in NX4.0.0. More...
virtual void	SetReverseSection (bool reverseSection)
	Sets the reverse_section Created in NX4.0.0. More...
virtual void	SetReverseSide (bool reverseSide)
	Sets the reverse side Created in NX4.0.0. More...
virtual void	SetUpdateOption (NXOpen::SmartObject::UpdateOption update)
	Set to plane update Created in NX5.0.0. More...
void	SynchronizeToPlane (NXOpen::Plane *sourcePlane)
	Synchronizes the input Plane object's parameters to this plane. More...
Public Member Functions inherited from NXOpen::SmartObject
void	Evaluate ()
	Evaluate a smart object. More...
void	ProtectFromDelete ()
	Protects the SmartObject from being deleted if any referencing objects are deleted. More...
void	ReleaseDeleteProtection ()
	Removes delete protection from the SmartObject. More...
void	RemoveParameters ()
	Removes the smart object parameters. More...
void	ReplaceParameters (NXOpen::SmartObject *otherSo)
	Edit a smart object by replacing its parameters using parameters of other smart object of the same class. More...
void	SetVisibility (NXOpen::SmartObject::VisibilityOption visibility)
	Sets the visibility. More...
NXOpen::SmartObject::UpdateOption	Update ()
	Returns the update option. More...
NXOpen::SmartObject::VisibilityOption	Visibility ()
	Returns the visibility. More...
Public Member Functions inherited from NXOpen::DisplayableObject
void	Blank ()
	Blanks the object. More...
int	Color ()
	Returns the color of the object. More...
void	Highlight ()
	Highlights the object. More...
bool	IsBlanked ()
	Returns the blank status of this object. More...
int	Layer ()
	Returns the layer that the object is in. More...
NXOpen::DisplayableObject::ObjectFont	LineFont ()
	Returns the line font of the object. More...
NXOpen::DisplayableObject::ObjectWidth	LineWidth ()
	Returns the line width of the object. More...
NXOpen::Point3d	NameLocation ()
	Returns the location of the object's name. More...
void	RedisplayObject ()
	Redisplays the object in all views. More...
void	RemoveViewDependency ()
	Remove dependency on all views from an object. More...
void	SetColor (int color)
	Sets the color of the object. More...
void	SetLayer (int layer)
	Sets the layer that the object is in. More...
void	SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
	Sets the line font of the object. More...
void	SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
	Sets the line width of the object. More...
void	SetNameLocation (const NXOpen::Point3d &location)
	Sets the location of the object's name. More...
void	Unblank ()
	Unblanks the object. More...
void	Unhighlight ()
	Unhighlights the object. More...
Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIterator *	CreateAttributeIterator ()
	Create an attribute iterator. More...
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type. More...
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not. More...
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title. More...
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title. More...
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not. More...
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not. More...
void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title. More...
void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title. More...
void	DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator Created in NX8.0.0. More...
void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...
virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
virtual NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type. More...
bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index. More...
bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index. More...
NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...
NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...
int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title. More...
int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title. More...
int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index. More...
int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index. More...
bool	GetNextUserAttribute (NXOpen::AttributeIterator *iterator, NXOpen::NXObject::AttributeInformation *info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
NXString	GetPdmReferenceAttributeValue (const NXString &attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...
NXString	GetPdmReferenceAttributeValue (const char *attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...
double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title. More...
double	GetRealAttribute (const char *title)
	Gets a real attribute by title. More...
double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index. More...
double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index. More...
NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title. More...
NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title. More...
NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index. More...
NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index. More...
NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title. More...
NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title. More...
NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...
NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...
NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
NXString	GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
NXString	GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...
int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...
bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...
bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (NXOpen::AttributeIterator *iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...
std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...
int	GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
int	GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...
bool	HasUserAttribute (NXOpen::AttributeIterator *iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator. More...
bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not. More...
virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object. More...
virtual NXString	Name ()
	Returns the custom name of the object. More...
virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence. More...
virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0. More...
virtual void	Print ()
	Prints a representation of this object to the system log file. More...
virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence. More...
void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute. More...
void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute. More...
void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...
void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...
void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute. More...
void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute. More...
void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...
void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...
void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute. More...
void	SetAttribute (const char *title, const char *value)
	Creates or modifies a string attribute. More...
void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...
void	SetAttribute (const char *title, const char *value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...
void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...
void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...
void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...
void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...
void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...
void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...
virtual void	SetName (const NXString &name)
	Sets the custom name of the object. More...
virtual void	SetName (const char *name)
	Sets the custom name of the object. More...
void	SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
	Sets the value of PDM Reference attribute on the object. More...
void	SetPdmReferenceAttribute (const char *attributeTitle, const char *attributeValue)
	Sets the value of PDM Reference attribute on the object. More...
void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string. More...
void	SetReferenceAttribute (const char *title, const char *value)
	Creates or modifies a string attribute which uses a reference string. More...
void	SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
void	SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute. More...
void	SetTimeAttribute (const char *title, const char *value)
	Creates or modifies a time attribute. More...
void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not. More...
void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...
void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...
void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...
void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...
void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...
void	SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...
void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...
void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...
void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute. More...
void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Additional Inherited Members
Public Types inherited from NXOpen::SmartObject
enum	UpdateOption {   UpdateOptionDontUpdate, UpdateOptionWithinModeling, UpdateOptionAfterModeling, UpdateOptionAfterParentBody,   UpdateOptionMixed }
	Specifies when the smart object updates. More...
enum	VisibilityOption { VisibilityOptionInvisible, VisibilityOptionVisible, VisibilityOptionVisibleIfParentInvisible }
	Specifies the smart object visibility. More...

Detailed Description

Represents an Plane class.

No Creator because of a problem with arrays in APIWRAP

Created in NX4.0.0.

Member Function Documentation

void NXOpen::Plane::ConvertToSmartPlane

(

)

Convert a fixed plane to a smart plane object to allow applying constraints to the plane.

Created in NX7.0.0.

License requirements : None

NXOpen::Plane* NXOpen::Plane::CopyPlane

(

)

Returns a new Plane object which is based on this plane's parameters.

Returns

Created in NX11.0.1.

License requirements : None

NXOpen::Plane* NXOpen::Plane::CopySoPlane

(

)

Creates an Plane using a datum plane feature.

Returns

Deprecated:

Deprecated in NX11.0.1. NXOpen.Plane.CopyPlane

Created in NX4.0.0.

License requirements : None

void NXOpen::Plane::DestroyPlane

(

)

Destroy the plane object
Created in NX6.0.3.

License requirements : None

void NXOpen::Plane::EditFixedPlane	(	const NXOpen::Point3d &	origin,
		const NXOpen::Matrix3x3 &	matrix
	)

Edit a fixed plane object with a new origin and matrix.

It will raise an error if the plane is not fixed.
Created in NX11.0.0.

License requirements : None

Parameters

origin	New Plane Origin
matrix	New Plane Matrix

virtual void NXOpen::Plane::Evaluate ( )

virtual

Evaluates the plane
Created in NX4.0.0.

License requirements : None

Implements NXOpen::IPlane.

virtual NXOpen::Expression* NXOpen::Plane::Expression ( )

virtual

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.

virtual NXOpen::PlaneTypes::FrenetSubtype NXOpen::Plane::FrenetSubtype ( )

virtual

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.

virtual NXOpen::PlaneTypes::AlternateType NXOpen::Plane::GetAlternate ( )

virtual

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.

virtual NXOpen::Matrix3x3 NXOpen::Plane::Matrix ( )

virtual

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

License requirements : None

Implements NXOpen::IPlane.

virtual NXOpen::PlaneTypes::MethodType NXOpen::Plane::Method ( )

virtual

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.

virtual NXOpen::Expression* NXOpen::Plane::OffsetExpression ( )

virtual

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

expTag

exptag

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.

virtual void NXOpen::Plane::SetAlternate ( NXOpen::PlaneTypes::AlternateType  type )

virtual

Sets the alternate type
Created in NX4.0.0.

License requirements : None

Parameters

type

type

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

valueExpression

offset value

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetExpression ( const char *  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

valueExpression

offset value

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

flip	flip direction

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetFrenetSubtype ( NXOpen::PlaneTypes::FrenetSubtype  subtype )

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

subtype

subtype

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

geom

geom

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

matrix

matrix

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

type

type

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

normal

normal

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetOffsetExpression ( const NXString &  valueExpression )

virtual

Sets the plane offset expression value.

Created in NX7.5.0.

License requirements : None

Parameters

valueExpression

offset value

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetOffsetExpression ( const char *  valueExpression )

virtual

Sets the plane offset expression value.

Created in NX7.5.0.

License requirements : None

Parameters

valueExpression

offset value

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetOffsetExpression ( NXOpen::Expression *  valueExpression )

virtual

Sets the plane offset expression.

Created in NX8.5.0.

License requirements : None

Parameters

valueExpression

offset value

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

flip	offset 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

origin

origin

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

percent

arclength 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

reverseSection

reverse 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

reverseSide

reverse side

Implements NXOpen::IPlane.

virtual void NXOpen::Plane::SetUpdateOption ( NXOpen::SmartObject::UpdateOption  update )

virtual

Set to plane update
Created in NX5.0.0.

License requirements : None

Parameters

update

update

Implements NXOpen::IPlane.

void NXOpen::Plane::SynchronizeToPlane

(

NXOpen::Plane *

sourcePlane

)

Synchronizes the input Plane object's parameters to this plane.

Created in NX11.0.1.

License requirements : None

Parameters

sourcePlane

sourceplane

---

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

• Plane.hxx