VEX —— Functions|Attribute And Intrinsics
目录
addvisualizer —— 追加detail属性visualizer
addattrib —— 添加属性到几何体
addpointattrib —— 添加点属性到几何体
addprimattrib —— 添加面属性到几何体
addvertexattrib —— 添加顶点属性到几何体
adddetailattrib —— 添加detail属性到几何体
attrib —— 读取属性值
point —— 读取点属性值
prim —— 读取面属性值
vertex —— 读取顶点属性值
detail —— 读取detail属性值
getattrib —— 读取属性值
pointattrib —— 读取点属性值
primattrib —— 读取面属性值
vertexattrib —— 读取顶点属性值
detailattrib —— 读取detail属性值
attribsize —— 返回几何体属性尺寸
pointattribsize —— 返回几何体点属性尺寸
primattribsize —— 返回几何体面属性尺寸
vertexattribsize —— 返回几何体顶点属性尺寸
detailattribsize —— 返回几何体detail属性尺寸
attribtype —— 返回几何体属性类型
pointattribtype —— 返回几何体点属性类型
primattribtype —— 返回几何体面属性类型
vertexattribtype —— 返回几何体顶点属性类型
detailattribtype —— 返回几何体detail属性类型
attribtypeinfo —— 返回几何体属性的变换元数据
pointattribtypeinfo —— 返回几何体点属性的变换元数据
primattribtypeinfo —— 返回几何体面属性的变换元数据
vertexattribtypeinfo —— 返回几何体面属性的变换元数据
detailattribtypeinfo —— 返回几何体detail属性的变换元数据
primintrinsic —— 读取面内在属性
detailintrinsic —— 读取detail内在属性
getattribute —— 复制一属性值到一变量
attribclass —— 返回几何体属性类型
attribdataid —— 返回几何体属性的数据id
findattribval —— 查找指定的属性值
findattribvalcount —— 返回匹配指定属性值的个数
idtopoint —— 通过id属性查找点
idtoprim —— 通过id属性查找面
nametopoint —— 通过name属性查找点
nametoprim —— 通过name属性查找面
hasattrib —— 检查指定属性是否存在
haspointattrib —— 检查指定点属性是否存在
hasprimattrib —— 检查指定面属性是否存在
hasvertexattrib —— 检查指定顶点属性是否存在
hasdetailattrib —— 检查指定detail属性是否存在
uniqueval —— 返回整数或字符串属性中唯一值中的一个
uniquevals —— 返回整数或字符串属性中唯一值集合
nuniqueval —— 返回整数或字符串属性中唯一值的数量
pointlocaltransforms —— 返回点局部变换的数组
pointtransform —— 返回点变换
pointtransforms —— 返回点变换数组
pointtransformrigid —— 返回rigid变换
pointtransformsrigid —— 返回rigid变换数组
prim_attribute —— 在指定的参数化uv位置对属性插值
primuv —— 在指定的参数化uvw位置对属性插值
uvsample —— 在特定uv坐标处对属性插值
primuvconvert —— 在不同空间内转化参数化uv位置
primduv —— 返回特定参数化uv位置的位置导数
priminteriorweights —— 查找顶点的索引和权重，在指定UVW坐标处计算内部点
curvearclen —— 计算曲线弧长
primarclen —— 使用参数化uv坐标计算曲线弧长
removeattrib —— 移除属性
removepointattrib —— 移除点属性
removeprimattrib —— 移除点属性
removevertexattrib —— 移除顶点属性
removedetailattrib —— 移除detail属性
removepointgroup —— 移除点组
removepointgroup —— 移除面组
removevertexgroup —— 移除顶点组
setattrib —— 设置属性值
setpointattrib —— 设置点属性值
setprimattrib —— 设置面属性值
setvertexattrib —— 设置顶点属性值
setdetailattrib —— 设置detail属性值
setprimintrinsic —— 设置面内在属性值
setdetailintrinsic —— 设置detail内在属性值
setattribtypeinfo —— 设置属性类型信息
setpointlocaltransforms —— 设置点局部变换数组
setpointtransform —— 设置指定点世界空间变换
setpointtransforms —— 设置点变换数组
addvisualizer —— 追加detail属性visualizer
- 如visualizer不存在，则创建该detail字符串数组属性；类似节点Visualize Attribute；
int addvisualizer(int geohandle, string op_url)
- op_url，字符串（形式为"op:/path/to/node"）；
addattrib —— 添加属性到几何体
- 如已知属性类型，使用adddetailattrib、addprimattrib、addpointattrib、addvertexattrib函数会更快；
int addattrib(int geohandle, string attribclass, string name,defvalue) int addattrib(int geohandle, string attribclass, string name, defvalue[])
- attribclass，属性类型，"detail" (或"global")， "point"， "prim"， "vertex"；也可使用组"primgroup"、"pointgroup"、"vertexgroup"；
- defvalue，默认值，字符串和数组类型没有默认值；
- 如属性已存在，将尝试转化为新类型；
- 返回值，geohandle，失败返回-1；
addpointattrib —— 添加点属性到几何体
//添加点属性到几何体 int addpointattrib(int geohandle, string name,defvalue) int addpointattrib(int geohandle, string name, defvalue[]) //添加点属性，及给定的变换信息 int addpointattrib(int geohandle, string name, defvalue, string typeinfo) int addpointattrib(int geohandle, string name, defvalue[], string typeinfo)
addprimattrib —— 添加面属性到几何体
//添加面属性到几何体 int addprimattrib(int geohandle, string name,defvalue) int addprimattrib(int geohandle, string name, defvalue[]) //添加面属性，及给定的变换信息 int addprimattrib(int geohandle, string name, defvalue, string typeinfo) int addprimattrib(int geohandle, string name, defvalue[], string typeinfo)
addvertexattrib —— 添加顶点属性到几何体
//添加顶点属性到几何体 int addvertexattrib(int geohandle, string name,defvalue) int addvertexattrib(int geohandle, string name, defvalue[]) //添加顶点属性，及给定的变换信息 int addvertexattrib(int geohandle, string name, defvalue, string typeinfo) int addvertexattrib(int geohandle, string name, defvalue[], string typeinfo)
adddetailattrib —— 添加detail属性到几何体
//添加detail属性到几何体 int adddetailattrib(int geohandle, string name,defvalue) int adddetailattrib(int geohandle, string name, defvalue[]) //添加detail属性，及给定的变换信息 int adddetailattrib(int geohandle, string name, defvalue, string typeinfo) int adddetailattrib(int geohandle, string name, defvalue[], string typeinfo)
以下函数无存在性检查（不识别是属性本身值是0或空，还是属性不存在而返回的0或空）
attrib —— 读取属性值
- 如已知属性类型，使用detail()、prim()、point()、vertex() 会更快；
attrib( geometry, string attribclass, string name, int elemnum) [] attrib( geometry, string attribclass, string name, int elemnum)
- attribclass，属性类型，"detail" (或"global")， "point"， "prim"， "vertex"；也可使用组"primgroup"、"pointgroup"、"vertexgroup"；
- name，属性名、组、或intrinsic；
- elemnum，待读取的点号、面号、顶点号；对detail属性忽略；
point —— 读取点属性值
point( geometry, string attribute_name, int pointnumber) [] point( geometry, string attribute_name, int pointnumber)
prim —— 读取面属性值
prim( geometry, string attribute_name, int primnumber) [] prim( geometry, string attribute_name, int primnumber)
vertex —— 读取顶点属性值
//读取顶点属性，使用线性顶点vertex( geometry, string attribute_name, int linear_vertex_index) [] vertex( geometry, string attribute_name, int linear_vertex_index) //读取顶点属性，使用顶点 vertex( geometry, string attribute_name, int prim_num, int vertex_num) [] vertex( geometry, string attribute_name, int prim_num, int vertex_num)
detail —— 读取detail属性值
detail( geometry, string attribute_name, int ignored=0) [] detail( geometry, string attribute_name, int ignored=0)
- ignored，总是忽略的；
以下函数有存在性检查（添加额外参数，成功返回1否则返回0）
getattrib —— 读取属性值
- 如已知属性类型，使用detailattrib()、primattrib()、pointattrib()、vertexattrib() 会更快；
getattrib( geometry, string attribclass, string attribute_name, int elemnum, int &success) [] getattrib( geometry, string attribclass, string attribute_name, int elemnum, int &success)
- attribclass，属性类型，"detail" (或"global")， "point"， "prim"， "vertex"；也可使用组"primgroup"、"pointgroup"、"vertexgroup"；
- name，属性名、组、或intrinsic；
- elemnum，待读取的点号、面号、顶点号；对detail属性，使用0；
pointattrib —— 读取点属性值
pointattrib( geometry, string attribute_name, int pointnumber, int &success) [] pointattrib( geometry, string attribute_name, int pointnumber, int &success)
primattrib —— 读取面属性值
primattrib( geometry, string attribute_name, int prim, int &success) [] primattrib( geometry, string attribute_name, int prim, int &success)
vertexattrib —— 读取顶点属性值
vertexattrib( geometry, string attribute_name, int linear_vertex_index, int &success) [] vertexattrib( geometry, string attribute_name, int linear_vertex_index, int &success)
- 使用vertexindex转化为线性顶点；
detailattrib —— 读取detail属性值
detailattrib( geometry, string attribute_name, int ignored, int &success) [] detailattrib( geometry, string attribute_name, int ignored, int &success)
- ignored，0对此参数；
attribsize —— 返回几何体属性尺寸
- 如已知属性类型，可使用detailattribsize、primattribsize、pointattribsize、vertexattribsize；
int attribsize(geometry, string attribclass, string attribute_name)
- 对vector，是组件数；
- 对int、float、string，返回1；
- 对数组，返回的是元组tuple的尺寸，元组tuple尺寸由attributecreate的size控制；
pointattribsize —— 返回几何体点属性尺寸
int pointattribsize(geometry, string attribute_name)
primattribsize —— 返回几何体面属性尺寸
int primattribsize(geometry, string attribute_name)
vertexattribsize —— 返回几何体顶点属性尺寸
int vertexattribsize(geometry, string attribute_name)
detailattribsize —— 返回几何体detail属性尺寸
int detailattribsize(geometry, string attribute_name)
attribtype —— 返回几何体属性类型
- 如已知属性类型， 可使用detailattribtype、primattribtype、pointattribtype、vertexattribtype；
int attribtype(geometry, string attribclass, string attribute_name)
- attribclass，属性类型，"detail" (或"global")， "point"， "prim"， "vertex"；也可使用组"primgroup"、"pointgroup"、"vertexgroup"；
返回值
- -1，属性未找到，或未知类型；
- 0，int；
- 1，float/vector；
- 2，string；
- 3，int数组，或int tuple；
- 4，float数组，后float tuple；
- 5，string数组；
- 6，dict；
- 7，dict数组；
pointattribtype —— 返回几何体点属性类型
int pointattribtype(geometry, string attribute_name)
primattribtype —— 返回几何体面属性类型
int primattribtype(geometry, string attribute_name)
vertexattribtype —— 返回几何体顶点属性类型
int vertexattribtype(geometry, string attribute_name)
detailattribtype —— 返回几何体detail属性类型
int detailattribtype(geometry, string attribute_name)
attribtypeinfo —— 返回几何体属性的变换元数据
- 如已知属性类型， 可使用detailattribtypeinfo()、primattribtypeinfo()、pointattribtypeinfo()、 vertexattribtypeinfo()；
string attribtypeinfo(geometry, string attribclass, string attribute_name)
pointattribtypeinfo —— 返回几何体点属性的变换元数据
string pointattribtypeinfo(geometry, string attribute_name)
primattribtypeinfo —— 返回几何体面属性的变换元数据
string primattribtypeinfo(geometry, string attribute_name)
vertexattribtypeinfo —— 返回几何体面属性的变换元数据
string vertexattribtypeinfo(geometry, string attribute_name)
detailattribtypeinfo —— 返回几何体detail属性的变换元数据
string detailattribtypeinfo(geometry, string attribute_name)
primintrinsic —— 读取面内在属性
- 内在属性类似属性，由Houdini按需计算；
primintrinsic( geometry, string intrinsic_name, int prim_num) [] primintrinsic( geometry, string intrinsic_name, int prim_num)
- intrinsic_name，内在属性名，如"pointattributes"、"pointcount"、"bounds"；
- 返回内在属性值，0表示内在属性不存在；
detailintrinsic —— 读取detail内在属性
- 内在属性类似属性，由Houdini按需计算；
detailintrinsic( geometry, string intrinsic_name) [] detailintrinsic( geometry, string intrinsic_name)
- intrinsic_name，内在属性名，如"pointattributes"、"pointcount"、"bounds"；
- 返回内在属性值，0表示内在属性不存在；
getattribute —— 复制一属性值到一变量
- 此函数不可读取输入属性，应使用getattrib；
int getattribute(string geometry,&value, string attribclass, string attribute_name, int element_number, int vertex_number) int getattribute(string geometry, &value[], string attribclass, string attribute_name, int element_number, int vertex_number)
getattribute("defgeo.bgeo", pos, "point", "P", 3, 0);
getattribute("op:/obj/geo1/color1", clr, "primitive", "Cd", 7);attribclass —— 返回几何体属性类型
string attribclass(geometry, string attribute_name)
- attribute_name，属性名，如多个层级存在相同属性名，返回最低级别的属性；
- 如属性不存在，返回空字符串“”；
attribdataid —— 返回几何体属性的数据id
- 数据id被用于高级形式的缓存，如属性数据id与之前相同，可表示该属性包含相同的数据；
- 返回数组的长度和内容没有被定义，不应假定任何布局；
- 除了普通属性，也支持“meta”属性类型，有额外的数据id：
- topology，顶点、点、面的整体连接，如任何点被重连类型或添加顶点都将改变；
- primitivelist，如prim内容发生变化，则数据id将改变；
- detail，数据id将追踪整个几何体；
int[] attribdataid(geometry, string attribclass, string attribute_name)
findattribval —— 查找指定的属性值
int findattribval(geometry, string attribclass, string attribute_name, int|stringvalue, int which=0) int[] findattribval( geometry, string attribclass, string attribute_name, int|stringvalue)
- which，如有多个匹配的值，此参数指定返回第几个；
- 返回值，默认返回第一个匹配的点、面、顶点号；-1表示无匹配的值；
注，大多数通过name或id的点/面属性案例，有更易使用的函数nametopoint、nametoprim、 idtopoint、idtoprim；
for (int point_num : findattribval(0, "point", "age", 10))
{
// ...do something with the point...
}int count = findattribvalcount(0, "point", "age", 10);
int point_num;
for (int i = 0; i < count; i++) {
point_num = findattribval(0, "point", "age", 10, i);
// ...do something with the point...
}findattribvalcount —— 返回匹配指定属性值的个数
int findattribvalcount(geometry, string attribclass, string attribute_name, int|stringvalue)
- 属性值需为int、或string；
idtopoint —— 通过id属性查找点
- 如没有id属性，使用点号作为id；
- 通过name属性查找点，使用nametopoint；
- 通过任意字符串或整数属性查找点，使用findattribval；
int idtopoint(geometry, int id)
- 返回点号，无给定ID的点返回-1；
idtoprim —— 通过id属性查找面
int idtoprim(geometry, int id)
- 返回面号，如无匹配返回-1；
nametopoint —— 通过name属性查找点
int nametopoint(geometry, string name)
- 返回点号，如无匹配的点返回-1；
nametoprim —— 通过name属性查找面
int nametoprim(geometry, string name)
- 返回面号，如无匹配的点返回-1；
hasattrib —— 检查指定属性是否存在
- 如已知属性类型， 可使用hasdetailattrib、hasprimattrib、haspointattrib、hasvertexattrib；
int hasattrib(geometry, string attribclass, string attribute_name)
- 返回值，存在返回1，不存在0；
haspointattrib —— 检查指定点属性是否存在
int haspointattrib(geometry, string attribute_name)
hasprimattrib —— 检查指定面属性是否存在
int hasprimattrib(geometry, string attribute_name)
hasvertexattrib —— 检查指定顶点属性是否存在
int hasvertexattrib(geometry, string attribute_name)
hasdetailattrib —— 检查指定detail属性是否存在
int hasdetailattrib(geometry, string attribute_name)
uniqueval —— 返回整数或字符串属性中唯一值中的一个
int|string uniqueval(geometry, string attribclass, string attribute_name, int which)
- 只对int、string属性起作用；
- which，返回唯一值的哪一个；
uniquevals —— 返回整数或字符串属性中唯一值集合
int[] uniquevals(geometry, string attribclass, string attribute_name) string[] uniquevals( geometry, string attribclass, string attribute_name)
nuniqueval —— 返回整数或字符串属性中唯一值的数量
int nuniqueval(geometry, string attribclass, string attribute_name)
int count = nuniqueval(0, "point", "foo");
for (int i = 0; i < count; i++) {
string val = uniqueval(0, "point", "foo", i);
// ...do something with the value...
}pointlocaltransforms —— 返回点局部变换的数组
- 此函数查询属性4@localtransform；
matrix[] pointlocaltransforms(geometry, int pnts[])
pointtransform —— 返回点变换
matrix pointtransform(geometry, int pnt)
pointtransforms —— 返回点变换数组
matrix[] pointtransforms(geometry, int pnts[]) matrix[] pointtransforms( geometry)
pointtransformrigid —— 返回rigid变换
matrix pointtransformrigid(geometry, int pnt)
pointtransformsrigid —— 返回rigid变换数组
matrix[] pointtransformsrigid(geometry, int pnts[]) matrix[] pointtransformsrigid( geometry)
prim_attribute —— 在指定的参数化uv位置对属性插值
- 如不需要测试错误，可使用primuv；
- 此函数不适用于特定的prim，如tetrahedra、polysoup；
//在给定的uv坐标，采样属性值 int prim_attribute(geometry, &value, string attribute_name, int prim_number, float u, float v) int prim_attribute( geometry, &value[], string attribute_name, int prim_number, float u, float v) //使用vector指定UVW坐标 int prim_attribute( geometry, &value, string attribute_name, int prim_number, vector uvw) int prim_attribute( geometry, &value[], string attribute_name, int prim_number, vector uvw)
- 使用内在prim UVs来指定的位置，要使用存储在UV属性内的UVs，可使用uvsample；
- 成功返回1，属性不存在返回0；
primuv —— 在指定的参数化uvw位置对属性插值
primuv( geometry, string attribute_name, int prim_num, vector uvw) [] primuv( geometry, string attribute_name, int prim_num, vector uvw)
- 使用内在prim UVs来指定的位置；要使用存储在UV属性内的UVs，使用uvsample；
- 返回属性插值，属性或面号不存在返回0；
uvsample —— 在特定uv坐标处对属性插值
uvsample( geometry, string attr_name, string uv_attr_name, vector uvw) [] uvsample( geometry, string attr_name, string uv_attr_name, vector uvw) uvsample( geometry, string primgroup, string attr_name, string uv_attr_name, vector uvw) [] uvsample( geometry, string primgroup, string attr_name, string uv_attr_name, vector uvw)
- 使用UV属性的UVs来指定位置；要使用内在prim UVs，使用primuv；
primuvconvert —— 在不同空间内转化参数化uv位置
vector2 primuvconvert(geometry, vector2 uv, int prim_num, int mode) vector2 primuvconvert( geometry, vector2 uv, int prim_num, int mode, float tolerance) float primuvconvert( geometry, float uv, int prim_num, int mode) float primuvconvert( geometry, float uv, int prim_num, int mode, float tolerance)
primduv —— 返回特定参数化uv位置的位置导数
vector primduv(string geometry, int prim_number, vector2 uv, int du, int dv)
priminteriorweights —— 查找顶点的索引和权重，在指定UVW坐标处计算内部点
int priminteriorweights(geometry, int prim_num, vector uvw, int &verts[], float &weights[])
curvearclen —— 计算曲线弧长
- 在prim上计算圆弧的长度，在使用参数化uv坐标的点数组定义的prim上；
- 可测量多边形面上或曲线上的距离；
float curvearclen(vector positions[], float uv1, float uv2, int closedflag, int fmt, int order) float curvearclen(vector positions[], float uv1, float uv2, int closedflag, int fmt, int order, int divs) float curvearclen(vector positions[], float uv1, float uv2, int closedflag, int fmt, int order, int divs, int primuvmode) float curvearclen(vector positions[], float uv1, float uv2, int closedflag, int fmt, int order, int divs, int primuvmode, float primuvtol)
- points，点数组定义的曲线curve；
- uv1、uv2，待测量参数化空间的起始、结束坐标；
- closeflag，曲线是否封闭，如封闭最后一个控制点将被连接到第一个点；
- fmt，待创建的曲线类型，0将创建polygon curve，1将创建bezier curve，2将创建NURBS curve；
- order，NURBS/Bezier curve的顺序，polygon curve忽略；
- dives，分段数，如为提供使用10；
- primuvmode，定义uv1/uv2坐标单位（primuvconvert查看模式列表）；
- primuvtol，uv坐标转换时的容差；
primarclen —— 使用参数化uv坐标计算曲线弧长
float primarclen(geometry, vector2 uv1, vector2 uv2, int prim_num) float primarclen( geometry, vector2 uv1, vector2 uv2, int prim_num, int divs) float primarclen( geometry, vector2 uv1, vector2 uv2, int prim_num, int divs, int primuvmode) float primarclen( geometry, vector2 uv1, vector2 uv2, int prim_num, int divs, int primuvmode, float primuvtol)
removeattrib —— 移除属性
int removeattrib(int geohandle, string attribclass, string name)
removepointattrib —— 移除点属性
int removepointgroup(int geohandle, string name)
removeprimattrib —— 移除点属性
int removeprimattrib(int geohandle, string name)
removevertexattrib —— 移除顶点属性
int removevertexattrib(int geohandle, string name)
removedetailattrib —— 移除detail属性
int removedetailattrib(int geohandle, string name)
removepointgroup —— 移除点组
int removepointgroup(int geohandle, string name)
removepointgroup —— 移除面组
int removeprimgroup(int geohandle, string name)
removevertexgroup —— 移除顶点组
int removevertexgroup(int geohandle, string name)
setattrib —— 设置属性值
- 如已知属性类型，可使用setdetailattrib、setprimattrib、setpointattrib、setvertexattrib；
- 如属性不存在，此函数创建属性，默认值为0或空；
- 如想控制数值属性的默认值，在设置属性前使用addattrib；
int setattrib(int geohandle, string attribclass, string attribute_name, int element_num, int vertex_num,value, string mode="set") int setattrib(int geohandle, string attribclass, string attribute_name, int element_num, int vertex_num, value[], string mode="set")
- 成功返回geohandle值，失败返回-1；
- mode，模式（可选项），控制对已存在属性的修改；
- “set”，覆盖属性；
- “add”，相加属性值；
- “min”，“minimum”，取最小值；
- “max”，“maximum”，取最大值；
- “mult”，“multiply”，属性值相乘；
- “toggle”，切换，对组成员有用；
- “append”，追加，对字符串、数组属性有效；
setpointattrib —— 设置点属性值
int setpointattrib(int geohandle, string name, int point_num,value, string mode="set") int setpointattrib(int geohandle, string name, int point_num, value[], string mode="set")
setprimattrib —— 设置面属性值
int setprimattrib(int geohandle, string name, int prim_num,value, string mode="set") int setprimattrib(int geohandle, string name, int prim_num, value[], string mode="set")
setvertexattrib —— 设置顶点属性值
int setvertexattrib(int geohandle, string name, int prim_num, int vertex_num,value, string mode="set") int setvertexattrib(int geohandle, string name, int prim_num, int vertex_num, value[], string mode="set")
setdetailattrib —— 设置detail属性值
int setdetailattrib(int geohandle, string name,value, string mode="set") int setdetailattrib(int geohandle, string name, value[], string mode="set")
setprimintrinsic —— 设置面内在属性值
int setprimintrinsic(int geohandle, string name, int prim_num,value, string mode="set") int setprimintrinsic(int geohandle, string name, int prim_num, value[], string mode="set")
setdetailintrinsic —— 设置detail内在属性值
int setdetailintrinsic(int geohandle, string name,value, string mode="set") int setdetailintrinsic(int geohandle, string name, value[], string mode="set")
setattribtypeinfo —— 设置属性类型信息
int setattribtypeinfo(int geohandle, string attribclass, string name, string typeinfo)
setpointlocaltransforms —— 设置点局部变换数组
int setpointlocaltransforms(int geohandle, int pnts[], matrix transforms[])
setpointtransform —— 设置指定点世界空间变换
int setpointtransform(int geohandle, int pt, matrix transform) int setpointtransform(int geohandle, int pt, matrix transform, int constrain)
setpointtransforms —— 设置点变换数组
matrix[] pointtransforms(geometry, int pnts[]) matrix[] pointtransforms( geometry)