NamedPointCollection

A collection of named points in the model.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Create various named points

project.NamedPoints:Add("pt1", 1.2, 1.4, 0.6)
project.NamedPoints:Add("pt2", 0.2, 2.4, 0.1)
project.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.NamedPoints) do
    point.Z = project.NamedPoints["pt1"].Z
end

Inheritance

The NamedPointCollection object is derived from the Object object.

Usage locations

The NamedPointCollection object can be accessed from the following locations:

Property List

Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

Add (name string, x Expression, y Expression, z Expression)
Create a named point from the given coordinate expressions. (Returns a NamedPoint object.)
Delete ()
Deletes the entity.
DeleteEntities ( List of Object)
Delete the given list of entities from the collection.
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.)
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.

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

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.
Delete ()
Deletes the entity.
DeleteEntities ( List of Object)
Delete the given list of entities from the collection.
Input Parameters
(List of Object)
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.
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.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.