NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::PlaneCollection Class Reference

Represents a collection of NXOpen::Plane . More...

Inheritance diagram for NXOpen::PlaneCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::PlaneCreatePlane (const NXOpen::Point3d &origin, const NXOpen::Vector3d &normal, NXOpen::SmartObject::UpdateOption updateOption)
 Creates an Plane without parameters. More...
 
NXOpen::PlaneCreatePlane (NXOpen::Features::Feature *datum)
 Creates an Plane using a datum plane feature. More...
 
NXOpen::PlaneCreatePlane (NXOpen::PlaneTypes::MethodType method, NXOpen::PlaneTypes::AlternateType alternate, const NXOpen::Point3d &origin, const NXOpen::Vector3d &normal, const NXString &expression, bool flip, bool percent, const std::vector< NXOpen::NXObject * > &geometry)
 Creates an Plane using a datum plane feature. More...
 
NXOpen::PlaneCreatePlane (NXOpen::PlaneTypes::MethodType method, NXOpen::PlaneTypes::AlternateType alternate, const NXOpen::Point3d &origin, const NXOpen::Vector3d &normal, const char *expression, bool flip, bool percent, const std::vector< NXOpen::NXObject * > &geometry)
 Creates an Plane using a datum plane feature. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of NXOpen::Plane .

Iterating this collection only returns live uncondemned objects contained in the owning part of the collection. Note that NXOpen::Plane is a smart object and many smart objects are condemned as they only exist to support other objects and are not displayed. Condemned objects will be deleted when their references go away.
To obtain an instance of this class, refer to NXOpen::BasePart

Created in NX4.0.0.

Member Function Documentation

iterator NXOpen::PlaneCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Plane* NXOpen::PlaneCollection::CreatePlane ( const NXOpen::Point3d origin,
const NXOpen::Vector3d normal,
NXOpen::SmartObject::UpdateOption  updateOption 
)

Creates an Plane without parameters.

Returns
the plane
Created in NX4.0.0.

License requirements : None
Parameters
originPlane Origin
normalPlane normal
updateOptionSmart Object update option
NXOpen::Plane* NXOpen::PlaneCollection::CreatePlane ( NXOpen::Features::Feature datum)

Creates an Plane using a datum plane feature.

Returns
the plane
Created in NX4.0.0.

License requirements : None
Parameters
datumDatum Feature
NXOpen::Plane* NXOpen::PlaneCollection::CreatePlane ( NXOpen::PlaneTypes::MethodType  method,
NXOpen::PlaneTypes::AlternateType  alternate,
const NXOpen::Point3d origin,
const NXOpen::Vector3d normal,
const NXString expression,
bool  flip,
bool  percent,
const std::vector< NXOpen::NXObject * > &  geometry 
)

Creates an Plane using a datum plane feature.

Returns
the plane
Created in NX4.0.0.

License requirements : None
Parameters
methodmethod
alternatealternate
originPlane Origin
normalPlane normal
expressionoffset value
NOTE: The full Unicode character set is not supported for this parameter.
flipflip direction
percentarclength or percent value
geometrygeometry
NXOpen::Plane* NXOpen::PlaneCollection::CreatePlane ( NXOpen::PlaneTypes::MethodType  method,
NXOpen::PlaneTypes::AlternateType  alternate,
const NXOpen::Point3d origin,
const NXOpen::Vector3d normal,
const char *  expression,
bool  flip,
bool  percent,
const std::vector< NXOpen::NXObject * > &  geometry 
)

Creates an Plane using a datum plane feature.

Returns
the plane
Created in NX4.0.0.

License requirements : None
Parameters
methodmethod
alternatealternate
originPlane Origin
normalPlane normal
expressionoffset value
NOTE: The full Unicode character set is not supported for this parameter.
flipflip direction
percentarclength or percent value
geometrygeometry
iterator NXOpen::PlaneCollection::end ( )

Returns an iterator addressing one past the last element.

tag_t NXOpen::PlaneCollection::Tag ( ) const

Returns the tag of this object.


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