Difference between revisions of "VS:Get2DComponentGroup"
From Vectorworks Developer
m (1 revision) |
(fix table) |
||
Line 6: | Line 6: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<desc> | <desc> | ||
− | Gets the specified 2D component group of a symbol definition or plug-in object or NULL if the group does not exist. | + | Gets the specified 2D component group of a symbol definition or plug-in object or NULL if the group does not exist. |
− | 2D component | + | |
− | Not Set | + | |
− | + | ''Table - 2D components'' | |
− | + | {| class = "wikitable_c" | |
− | Top and Bottom Cut | + | ! Constant !! 2D component |
− | + | |- | |
− | + | | 0 || Not Set | |
− | Front and Back Cut | + | |- |
− | + | | 1 || Top | |
− | + | |- | |
− | Left and Right Cut | + | | 2 || Bottom |
+ | |- | ||
+ | | 3 || Top and Bottom Cut | ||
+ | |- | ||
+ | | 4 || Front | ||
+ | |- | ||
+ | | 5 || Back | ||
+ | |- | ||
+ | | 6 || Front and Back Cut | ||
+ | |- | ||
+ | | 7 || Left | ||
+ | |- | ||
+ | | 8 || Right | ||
+ | |- | ||
+ | | 9 || Left and Right Cut | ||
+ | |} | ||
</desc> | </desc> | ||
Latest revision as of 01:47, 14 February 2019
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Gets the specified 2D component group of a symbol definition or plug-in object or NULL if the group does not exist.
Table - 2D components
Constant | 2D component |
---|---|
0 | Not Set |
1 | Top |
2 | Bottom |
3 | Top and Bottom Cut |
4 | Front |
5 | Back |
6 | Front and Back Cut |
7 | Left |
8 | Right |
9 | Left and Right Cut |
FUNCTION Get2DComponentGroup(
objectHandle :HANDLE;
component :INTEGER) : HANDLE;
def vs.Get2DComponentGroup(objectHandle, component): return HANDLE
Parameters
objectHandle HANDLE Handle to the object. component INTEGER 2D component.
Return Value
Returns a HANDLE to the specified 2D component group.Version
Availability: from Vectorworks 2019See Also
VS Functions:VS:Set2DComponentGroup | VS:SetTopPlan2DComp | VS:GetTopPlan2DComp
VS Functions:
[[VS:Set2DComponentGroup]] | [[VS:SetTopPlan2DComp]]
| [[VS:GetTopPlan2DComp]]