NamedPointCollection
A collection of named points in the model.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Create various named points project.Definitions.NamedPoints:Add("pt1", 1.2, 1.4, 0.6) project.Definitions.NamedPoints:Add("pt2", 0.2, 2.4, 0.1) project.Definitions.NamedPoints:Add("pt3", -1.2, 2.5, 1.0) -- Set the Z value of "pt1" for all the named points for key,point in pairs(project.Definitions.NamedPoints) do point.Point.N = project.Definitions.NamedPoints["pt1"].Point.N end
Inheritance
The NamedPointCollection object is derived from the Object object.
Usage locations
The NamedPointCollection object can be accessed from the following locations:
- Collection lists
- ModelDefinitions object has collection NamedPoints.
Property List
Method List
- Add (name string, x Expression, y Expression, z Expression)
- Create a named point from the given coordinate expressions. (Returns a NamedPoint object.)
- Contains (label string)
- Checks if the collection contains an item with the given label. (Returns a boolean object.)
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object object.)
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
- Item (index number)
- Returns the NamedPoint for the given index in the collection. (Returns a NamedPoint object.)
- Item (label string)
- Returns the NamedPoint for the given label in the collection. (Returns a NamedPoint object.)
- Items ()
- Returns a table of NamedPoint items. (Returns a UnsupportedType(List of NamedPoint) object.)
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- UniqueName (label string)
- Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a string object.)
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
Method Details
- Add (name string, x Expression, y Expression, z Expression)
- Create a named point from the given coordinate expressions.
- Input Parameters
- name(string)
- The point name.
- x(Expression)
- The X coordinate expression.
- y(Expression)
- The Y coordinate expression.
- z(Expression)
- The Z coordinate expression.
- Return
- NamedPoint
- The named point.
- Contains (label string)
- Checks if the collection contains an item with the given label.
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
- Return
- table
- A table defining the properties.
- Item (index number)
- Returns the NamedPoint for the given index in the collection.
- Input Parameters
- index(number)
- The index of the NamedPoint.
- Return
- NamedPoint
- The item in the collection
- Item (label string)
- Returns the NamedPoint for the given label in the collection.
- Input Parameters
- label(string)
- The label of the NamedPoint.
- Return
- NamedPoint
- The item in the collection
- Items ()
- Returns a table of NamedPoint items.
- Return
- UnsupportedType(List of NamedPoint)
- The list of items in the collection
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- Input Parameters
- properties(Object)
- A table of properties defining the new state of the object.
- UniqueName (label string)
- Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.