NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.Ellipse Class Reference

Represents an ellipse curve. More...

Inheritance diagram for NXOpen.Ellipse:
NXOpen.Conic NXOpen.Curve NXOpen.SmartObject NXOpen.ICurve NXOpen.IProfile NXOpen.DisplayableObject NXOpen.IBaseCurve NXOpen.INXObject NXOpen.NXObject NXOpen.IFitTo NXOpen.INXObject NXOpen.INXObject NXOpen.INXObject

Public Member Functions

unsafe void GetParameters (out double majorRadius, out double minorRadius, out double startAngle, out double endAngle, out double rotationAngle, out NXOpen.Point3d center)
 Gets the parameters of the ellipse - the major/minor radii, start/end angles and the centre of the ellipse. More...
 
unsafe void SetParameters (double majorRadius, double minorRadius, double startAngle, double endAngle, double rotationAngle, NXOpen.Point3d center)
 Sets the parameters of the ellipse - the major/minor radii, start/end angles and the centre of the ellipse. More...
 
- Public Member Functions inherited from NXOpen.Conic
unsafe void GetOrientation (out NXOpen.Point3d center, out NXOpen.Vector3d xDirection, out NXOpen.Vector3d yDirection)
 Gets the orientation of the conic. More...
 
unsafe void SetOrientation (NXOpen.Point3d center, NXOpen.Vector3d xDirection, NXOpen.Vector3d yDirection)
 Sets the center of the conic. More...
 
unsafe void SetParameters (NXOpen.Point3d startPoint, NXOpen.Point3d endPoint, NXOpen.Point3d anchorPoint, double rho)
 Sets the start, end, anchor, rho of the conic. More...
 
- Public Member Functions inherited from NXOpen.Curve
unsafe
NXOpen.Drawings.DraftingCurveInfo 
GetDraftingCurveInfo ()
 Creates new DraftingCurveInfo object More...
 
unsafe double GetLength ()
 Returns the length of the object More...
 
- Public Member Functions inherited from NXOpen.SmartObject
unsafe void RemoveParameters ()
 Removes the smart object parameters. More...
 
unsafe void ReplaceParameters (NXOpen.SmartObject otherSo)
 Edit a smart object by replacing its parameters using parameters of other smart object of the same class. More...
 
unsafe void Evaluate ()
 Evaluate a smart object. More...
 
unsafe void SetVisibility (NXOpen.SmartObject.VisibilityOption visibility)
 Sets the visibility. More...
 
unsafe void ProtectFromDelete ()
 Protects the SmartObject from being deleted if any referencing objects are deleted. More...
 
unsafe void ReleaseDeleteProtection ()
 Removes delete protection from the SmartObject. More...
 
- Public Member Functions inherited from NXOpen.DisplayableObject
unsafe void Blank ()
 Blanks the object. More...
 
unsafe void Unblank ()
 Unblanks the object. More...
 
unsafe void Highlight ()
 Highlights the object. More...
 
unsafe void Unhighlight ()
 Unhighlights the object. More...
 
unsafe void SetNameLocation (NXOpen.Point3d location)
 Sets the location of the object's name. More...
 
unsafe void RedisplayObject ()
 Redisplays the object in all views. More...
 
unsafe void RemoveViewDependency ()
 Remove dependency on all views from an object. More...
 
- Public Member Functions inherited from NXOpen.NXObject
unsafe void SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
unsafe NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator More...
 
unsafe bool HasUserAttribute (NXOpen.AttributeIterator iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator More...
 
unsafe bool HasUserAttribute (string 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...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
unsafe 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...
 
unsafe int GetUserAttributeSize (string 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...
 
unsafe bool GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation 
GetUserAttribute (string 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...
 
unsafe bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.ComputationalTime 
GetComputationalTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
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...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
unsafe string GetUserAttributeAsString (string 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...
 
unsafe void DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator More...
 
unsafe void DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
unsafe 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...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttribute (string 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...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
 Deletes all attributes of a specific type. More...
 
unsafe 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...
 
unsafe void SetAttribute (string title, int value)
 Creates or modifies an integer attribute. More...
 
unsafe void SetAttribute (string title, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, double value)
 Creates or modifies a real attribute. More...
 
unsafe void SetAttribute (string title, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, string value)
 Creates or modifies a string attribute. More...
 
unsafe void SetAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
unsafe void SetAttribute (string title, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetTimeAttribute (string title, string value)
 Creates or modifies a time attribute. More...
 
unsafe void SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. More...
 
unsafe string GetReferenceAttribute (string title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
 Deletes an attribute by type and title. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
unsafe void SetReferenceAttribute (string title, string value)
 Creates or modifies a string attribute which uses a reference string. More...
 
unsafe void SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 

Properties

unsafe double EndAngle [get]
 Returns the end angle. More...
 
unsafe double MajorRadius [get]
 Returns the major radius. More...
 
unsafe double MinorRadius [get]
 Returns the minor radius. More...
 
unsafe double StartAngle [get]
 Returns the start angle. More...
 
- Properties inherited from NXOpen.Conic
unsafe NXOpen.Point3d CenterPoint [get]
 Returns the center. More...
 
unsafe NXOpen.NXMatrix Matrix [get]
 Returns the orientation matrix. More...
 
unsafe double RotationAngle [get]
 Returns the rotation angle. More...
 
- Properties inherited from NXOpen.Curve
unsafe bool IsReference [get]
 Returns the reference state of a curve More...
 
- Properties inherited from NXOpen.SmartObject
unsafe
NXOpen.SmartObject.UpdateOption 
Update [get]
 Returns the update option. More...
 
unsafe
NXOpen.SmartObject.VisibilityOption 
Visibility [get]
 Returns the visibility. More...
 
- Properties inherited from NXOpen.DisplayableObject
unsafe int Color [get, set]
 Returns or sets the color of the object. More...
 
unsafe bool IsBlanked [get]
 Returns the blank status of this object. More...
 
unsafe int Layer [get, set]
 Returns or sets the layer that the object is in. More...
 
unsafe
NXOpen.DisplayableObject.ObjectFont 
LineFont [get, set]
 Returns or sets the line font of the object. More...
 
unsafe
NXOpen.DisplayableObject.ObjectWidth 
LineWidth [get, set]
 Returns or sets the line width of the object. More...
 
unsafe NXOpen.Point3d NameLocation [get]
 Returns the location of the object's name. More...
 
- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 
- Properties inherited from NXOpen.INXObject
bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
string Name [get]
 Returns the custom name of the object. More...
 
NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.SmartObject
enum  UpdateOption {
  DontUpdate, WithinModeling, AfterModeling, AfterParentBody,
  Mixed
}
 Specifies when the smart object updates. More...
 
enum  VisibilityOption { Invisible, Visible, VisibleIfParentInvisible }
 Specifies the smart object visibility. More...
 

Detailed Description

Represents an ellipse curve.

The start and end angles are measured relative to the X and Y axes of the orientation matrix of the conic.

To create a new instance of this class, use NXOpen.CurveCollection.CreateEllipse

Created in NX3.0.0

Member Function Documentation

unsafe void NXOpen.Ellipse.GetParameters ( out double  majorRadius,
out double  minorRadius,
out double  startAngle,
out double  endAngle,
out double  rotationAngle,
out NXOpen.Point3d  center 
)

Gets the parameters of the ellipse - the major/minor radii, start/end angles and the centre of the ellipse.

Created in NX11.0.0

License requirements: None.

Parameters
majorRadius
minorRadius
startAngleIn radians
endAngleIn radians
rotationAngleIn radians
center
unsafe void NXOpen.Ellipse.SetParameters ( double  majorRadius,
double  minorRadius,
double  startAngle,
double  endAngle,
double  rotationAngle,
NXOpen.Point3d  center 
)

Sets the parameters of the ellipse - the major/minor radii, start/end angles and the centre of the ellipse.

Created in NX11.0.0

License requirements: None.

Parameters
majorRadius
minorRadius
startAngleIn radians
endAngleIn radians
rotationAngleIn radians
center

Property Documentation

unsafe double NXOpen.Ellipse.EndAngle
get

Returns the end angle.

Created in NX3.0.0

License requirements: None.

unsafe double NXOpen.Ellipse.MajorRadius
get

Returns the major radius.

Created in NX3.0.0

License requirements: None.

unsafe double NXOpen.Ellipse.MinorRadius
get

Returns the minor radius.

Created in NX3.0.0

License requirements: None.

unsafe double NXOpen.Ellipse.StartAngle
get

Returns the start angle.

Created in NX3.0.0

License requirements: None.


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